From 202ff89c00110f26df18508f79e2cedb6defa37c Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Tue, 4 Jan 2022 02:34:16 +0000 Subject: [PATCH 01/79] tasksv2 rebase Signed-off-by: Teo Koon Peng --- Pipfile | 4 + packages/api-client/generate-openapi.py | 4 +- packages/api-client/lib/openapi/api.ts | 1849 ++++++++--------- packages/api-client/lib/version.ts | 2 +- packages/api-server/api_server/__main__.py | 13 + packages/api-server/api_server/gateway.py | 70 +- .../api-server/api_server/models/__init__.py | 5 +- .../api-server/api_server/models/fleets.py | 52 +- .../api-server/api_server/models/tasks.py | 147 +- .../models/tortoise_models/__init__.py | 4 +- .../models/tortoise_models/fleet_state.py | 17 - .../models/tortoise_models/task_summary.py | 23 - .../api_server/repositories/__init__.py | 2 + .../api_server/repositories/fleets.py | 40 + .../api-server/api_server/repositories/rmf.py | 154 +- .../api_server/repositories/tasks.py | 40 + .../api-server/api_server/rmf_gateway_app.py | 88 + .../api-server/api_server/rmf_io/__init__.py | 2 +- .../api_server/rmf_io/book_keeper.py | 53 +- .../api-server/api_server/rmf_io/events.py | 19 +- .../api_server/rmf_io/rmf_service.py | 77 + .../api_server/rmf_io/test_rmf_service.py | 114 + .../api-server/api_server/routes/fleets.py | 125 +- .../api_server/routes/tasks/dispatcher.py | 63 - .../api_server/routes/tasks/tasks.py | 181 +- .../api_server/routes/tasks/test_tasks.py | 49 + .../api_server/routes/tasks/utils.py | 27 - .../api_server/routes/test_fleets.py | 86 +- .../api-server/api_server/services/tasks.py | 70 - .../api_server/services/test_tasks.py | 51 - .../api-server/api_server/test/test_data.py | 593 +++++- .../api_server/test_rmf_gateway_app.py | 37 + 32 files changed, 2141 insertions(+), 1920 deletions(-) delete mode 100644 packages/api-server/api_server/models/tortoise_models/fleet_state.py delete mode 100644 packages/api-server/api_server/models/tortoise_models/task_summary.py create mode 100644 packages/api-server/api_server/repositories/fleets.py create mode 100644 packages/api-server/api_server/repositories/tasks.py create mode 100644 packages/api-server/api_server/rmf_gateway_app.py create mode 100644 packages/api-server/api_server/rmf_io/rmf_service.py create mode 100644 packages/api-server/api_server/rmf_io/test_rmf_service.py delete mode 100644 packages/api-server/api_server/routes/tasks/dispatcher.py create mode 100644 packages/api-server/api_server/routes/tasks/test_tasks.py delete mode 100644 packages/api-server/api_server/routes/tasks/utils.py delete mode 100644 packages/api-server/api_server/services/tasks.py delete mode 100644 packages/api-server/api_server/services/test_tasks.py create mode 100644 packages/api-server/api_server/test_rmf_gateway_app.py diff --git a/Pipfile b/Pipfile index 774c35762..9648c2f9c 100644 --- a/Pipfile +++ b/Pipfile @@ -14,6 +14,10 @@ coverage = "~=5.5" api-server = {editable = true, path = "./packages/api-server"} requests = "~=2.25" asyncpg = "~=0.24.0" +# TODO: install datamodel-code-generator in it's own venv. +# Because this breaks dependencies because pipenv cannot find a suitable version of black +# even though it is available (it's is known "feature" of pipenv). +# datamodel-code-generator = "~=0.11.15" websocket-client = "~=1.2.3" # reporting-server reporting-server = {editable = true, path = "./packages/reporting-server"} diff --git a/packages/api-client/generate-openapi.py b/packages/api-client/generate-openapi.py index 00e3e967b..bca133710 100644 --- a/packages/api-client/generate-openapi.py +++ b/packages/api-client/generate-openapi.py @@ -1,9 +1,9 @@ import json import os -from api_server.app import App +from api_server.app import app here = os.path.realpath(os.path.dirname(__file__)) os.makedirs(f"{here}/build", exist_ok=True) with open(f"{here}/build/openapi.json", "w") as f: - json.dump(App().fapi.openapi(), f) + json.dump(app.openapi(), f) diff --git a/packages/api-client/lib/openapi/api.ts b/packages/api-client/lib/openapi/api.ts index 79c724979..4763b378b 100644 --- a/packages/api-client/lib/openapi/api.ts +++ b/packages/api-client/lib/openapi/api.ts @@ -83,40 +83,33 @@ export interface AffineImage { /** * * @export - * @interface Behavior + * @interface Booking */ -export interface Behavior { +export interface Booking { /** - * + * The unique identifier for this task * @type {string} - * @memberof Behavior + * @memberof Booking */ - name: string; + id: string; /** * - * @type {Array} - * @memberof Behavior + * @type {number} + * @memberof Booking */ - parameters: Array; -} -/** - * - * @export - * @interface BehaviorParameter - */ -export interface BehaviorParameter { + unix_millis_earliest_start_time?: number; /** - * - * @type {string} - * @memberof BehaviorParameter + * Priority information about this task + * @type {object | string} + * @memberof Booking */ - name: string; + priority?: object | string; /** - * - * @type {string} - * @memberof BehaviorParameter + * Information about how and why this task was booked + * @type {Array} + * @memberof Booking */ - value: string; + labels?: Array; } /** * @@ -146,128 +139,66 @@ export interface BuildingMap { /** * * @export - * @interface CancelTask + * @interface CancelTaskRequest */ -export interface CancelTask { +export interface CancelTaskRequest { /** - * + * Indicate that this is a task cancellation request * @type {string} - * @memberof CancelTask + * @memberof CancelTaskRequest */ - task_id: string; -} -/** - * - * @export - * @interface Clean - */ -export interface Clean { + type: string; /** - * + * Specify the task ID to cancel * @type {string} - * @memberof Clean + * @memberof CancelTaskRequest */ - start_waypoint: string; -} -/** - * - * @export - * @interface CleanTaskDescription - */ -export interface CleanTaskDescription { + task_id: string; /** - * - * @type {string} - * @memberof CleanTaskDescription + * Labels to describe the purpose of the cancellation + * @type {Array} + * @memberof CancelTaskRequest */ - cleaning_zone: string; + labels?: Array; } /** * * @export - * @interface Delivery + * @interface Cancellation */ -export interface Delivery { - /** - * - * @type {string} - * @memberof Delivery - */ - task_id: string; - /** - * - * @type {Array} - * @memberof Delivery - */ - items: Array; - /** - * - * @type {string} - * @memberof Delivery - */ - pickup_place_name: string; +export interface Cancellation { /** - * - * @type {string} - * @memberof Delivery - */ - pickup_dispenser: string; - /** - * - * @type {Behavior} - * @memberof Delivery - */ - pickup_behavior: Behavior; - /** - * - * @type {string} - * @memberof Delivery - */ - dropoff_place_name: string; - /** - * - * @type {string} - * @memberof Delivery + * The time that the cancellation request arrived + * @type {number} + * @memberof Cancellation */ - dropoff_ingestor: string; + unix_millis_request_time: number; /** - * - * @type {Behavior} - * @memberof Delivery + * Labels to describe the cancel request + * @type {Array} + * @memberof Cancellation */ - dropoff_behavior: Behavior; + labels: Array; } /** * * @export - * @interface DeliveryTaskDescription + * @interface Description */ -export interface DeliveryTaskDescription { - /** - * - * @type {string} - * @memberof DeliveryTaskDescription - */ - pickup_place_name: string; - /** - * - * @type {string} - * @memberof DeliveryTaskDescription - */ - pickup_dispenser: string; - /** - * - * @type {string} - * @memberof DeliveryTaskDescription - */ - dropoff_ingestor: string; +export interface Description { /** * * @type {string} - * @memberof DeliveryTaskDescription + * @memberof Description */ - dropoff_place_name: string; + category: string; } +/** + * Detailed information about a task, phase, or event + * @export + * @interface Detail + */ +export interface Detail {} /** * * @export @@ -306,31 +237,6 @@ export interface DispenserHealth { */ id_: string; } -/** - * - * @export - * @interface DispenserRequestItem - */ -export interface DispenserRequestItem { - /** - * - * @type {string} - * @memberof DispenserRequestItem - */ - type_guid: string; - /** - * - * @type {number} - * @memberof DispenserRequestItem - */ - quantity: number; - /** - * - * @type {string} - * @memberof DispenserRequestItem - */ - compartment_name: string; -} /** * * @export @@ -502,21 +408,64 @@ export interface DoorState { /** * * @export - * @interface Fleet + * @interface EventState */ -export interface Fleet { +export interface EventState { /** * + * @type {number} + * @memberof EventState + */ + id: number; + /** + * A simple token representing how the task is proceeding + * @type {Status1} + * @memberof EventState + */ + status?: Status1; + /** + * The brief name of the event * @type {string} - * @memberof Fleet + * @memberof EventState */ - name: string; + name?: string; + /** + * Detailed information about the event + * @type {Detail} + * @memberof EventState + */ + detail?: Detail; + /** + * This event may depend on other events. This array contains the IDs of those other event dependencies. + * @type {Array} + * @memberof EventState + */ + deps?: Array; +} +/** + * + * @export + * @interface FleetLog + */ +export interface FleetLog { /** * - * @type {FleetState} - * @memberof Fleet + * @type {string} + * @memberof FleetLog + */ + name?: string; + /** + * Log for the overall fleet + * @type {Array} + * @memberof FleetLog + */ + log?: Array; + /** + * Dictionary of logs for the individual robots. The keys (property names) are the robot names. + * @type {{ [key: string]: Array; }} + * @memberof FleetLog */ - state: FleetState; + robots?: { [key: string]: Array }; } /** * @@ -529,13 +478,13 @@ export interface FleetState { * @type {string} * @memberof FleetState */ - name: string; + name?: string; /** - * - * @type {Array} + * A dictionary of the states of the robots that belong to this fleet + * @type {{ [key: string]: RobotState; }} * @memberof FleetState */ - robots: Array; + robots?: { [key: string]: RobotState }; } /** * @@ -718,6 +667,69 @@ export interface IngestorState { */ seconds_remaining: number; } +/** + * + * @export + * @interface Interruption + */ +export interface Interruption { + /** + * The time that the interruption request arrived + * @type {number} + * @memberof Interruption + */ + unix_millis_request_time: number; + /** + * Labels to describe the purpose of the interruption + * @type {Array} + * @memberof Interruption + */ + labels: Array; + /** + * Information about the resume request that ended this interruption. This field will be missing if the interruption is still active. + * @type {ResumedBy} + * @memberof Interruption + */ + resumed_by?: ResumedBy; +} +/** + * + * @export + * @interface Issue + */ +export interface Issue { + /** + * Category of the robot\'s issue + * @type {string} + * @memberof Issue + */ + category?: string; + /** + * Detailed information about the issue + * @type {object | Array | string} + * @memberof Issue + */ + detail?: object | Array | string; +} +/** + * + * @export + * @interface Killed + */ +export interface Killed { + /** + * The time that the cancellation request arrived + * @type {number} + * @memberof Killed + */ + unix_millis_request_time: number; + /** + * Labels to describe the kill request + * @type {Array} + * @memberof Killed + */ + labels: Array; +} /** * * @export @@ -948,119 +960,89 @@ export interface LiftState { /** * * @export - * @interface Location + * @interface Location2D */ -export interface Location { +export interface Location2D { /** * - * @type {Time} - * @memberof Location + * @type {string} + * @memberof Location2D */ - t: Time; + map: string; /** * * @type {number} - * @memberof Location + * @memberof Location2D */ x: number; /** * * @type {number} - * @memberof Location + * @memberof Location2D */ y: number; /** * * @type {number} - * @memberof Location + * @memberof Location2D */ yaw: number; - /** - * - * @type {boolean} - * @memberof Location - */ - obey_approach_speed_limit: boolean; - /** - * - * @type {number} - * @memberof Location - */ - approach_speed_limit: number; - /** - * - * @type {string} - * @memberof Location - */ - level_name: string; - /** - * - * @type {number} - * @memberof Location - */ - index: number; } /** * * @export - * @interface Loop + * @interface LogEntry */ -export interface Loop { +export interface LogEntry { /** - * - * @type {string} - * @memberof Loop + * Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around. + * @type {number} + * @memberof LogEntry */ - task_id: string; + seq: number; /** - * - * @type {string} - * @memberof Loop + * The importance level of the log entry + * @type {Tier} + * @memberof LogEntry */ - robot_type: string; + tier: Tier; /** * * @type {number} - * @memberof Loop - */ - num_loops: number; - /** - * - * @type {string} - * @memberof Loop + * @memberof LogEntry */ - start_name: string; + unix_millis_time: number; /** - * + * The text of the log entry * @type {string} - * @memberof Loop + * @memberof LogEntry */ - finish_name: string; + text: string; } /** * * @export - * @interface LoopTaskDescription + * @interface ModelError */ -export interface LoopTaskDescription { +export interface ModelError { /** - * + * A standard code for the kind of error that has occurred * @type {number} - * @memberof LoopTaskDescription + * @memberof ModelError */ - num_loops: number; + code?: number; /** - * + * The category of the error * @type {string} - * @memberof LoopTaskDescription + * @memberof ModelError */ - start_name: string; + category?: string; /** - * + * Details about the error * @type {string} - * @memberof LoopTaskDescription + * @memberof ModelError */ - finish_name: string; + detail?: string; } /** * @@ -1124,6 +1106,55 @@ export interface Permission { */ action: string; } +/** + * + * @export + * @interface Phase + */ +export interface Phase { + /** + * + * @type {number} + * @memberof Phase + */ + id: number; + /** + * The category of this task or phase + * @type {string} + * @memberof Phase + */ + category?: string; + /** + * + * @type {Detail} + * @memberof Phase + */ + detail?: Detail; + /** + * An estimate, in milliseconds, of how long the subject will take to complete + * @type {number} + * @memberof Phase + */ + estimate_millis?: number; + /** + * + * @type {number} + * @memberof Phase + */ + final_event_id?: number; + /** + * A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers. + * @type {{ [key: string]: EventState; }} + * @memberof Phase + */ + events?: { [key: string]: EventState }; + /** + * Information about any skip requests that have been received + * @type {{ [key: string]: SkipPhaseRequest; }} + * @memberof Phase + */ + skip_requests?: { [key: string]: SkipPhaseRequest }; +} /** * * @export @@ -1215,90 +1246,21 @@ export interface PostUsers { /** * * @export - * @interface Priority - */ -export interface Priority { - /** - * - * @type {number} - * @memberof Priority - */ - value: number; -} -/** - * - * @export - * @interface Robot - */ -export interface Robot { - /** - * - * @type {string} - * @memberof Robot - */ - fleet: string; - /** - * - * @type {string} - * @memberof Robot - */ - name: string; - /** - * - * @type {RobotState} - * @memberof Robot - */ - state: RobotState; - /** - * - * @type {Array} - * @memberof Robot - */ - tasks?: Array; -} -/** - * - * @export - * @interface RobotHealth - */ -export interface RobotHealth { - /** - * - * @type {string} - * @memberof RobotHealth - */ - health_status: string | null; - /** - * - * @type {string} - * @memberof RobotHealth - */ - health_message?: string | null; - /** - * - * @type {string} - * @memberof RobotHealth - */ - id_: string; -} -/** - * - * @export - * @interface RobotMode + * @interface ResumedBy */ -export interface RobotMode { +export interface ResumedBy { /** - * + * The time that the resume request arrived * @type {number} - * @memberof RobotMode + * @memberof ResumedBy */ - mode: number; + unix_millis_request_time?: number; /** - * - * @type {number} - * @memberof RobotMode + * Labels to describe the resume request + * @type {Array} + * @memberof ResumedBy */ - mode_request_id: number; + labels: Array; } /** * @@ -1311,316 +1273,309 @@ export interface RobotState { * @type {string} * @memberof RobotState */ - name: string; + name?: string; /** - * - * @type {string} + * A simple token representing the status of the robot + * @type {Status} * @memberof RobotState */ - model: string; + status?: Status; /** - * + * The ID of the task this robot is currently working on. Empty string if the robot is not working on a task. * @type {string} * @memberof RobotState */ - task_id: string; + task_id?: string; /** * * @type {number} * @memberof RobotState */ - seq: number; + unix_millis_time?: number; /** * - * @type {RobotMode} + * @type {Location2D} * @memberof RobotState */ - mode: RobotMode; + location?: Location2D; /** - * + * State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged) * @type {number} * @memberof RobotState */ - battery_percent: number; - /** - * - * @type {Location} - * @memberof RobotState - */ - location: Location; + battery?: number; /** - * - * @type {Array} + * A list of issues with the robot that operators need to address + * @type {Array} * @memberof RobotState */ - path: Array; + issues?: Array; } /** - * + * Template for defining a response message that only indicates success and describes any errors * @export - * @interface Station + * @interface SimpleResponse */ -export interface Station { +export interface SimpleResponse { /** - * - * @type {string} - * @memberof Station - */ - task_id: string; - /** - * - * @type {string} - * @memberof Station + * The request failed + * @type {boolean} + * @memberof SimpleResponse */ - robot_type: string; + success: boolean; /** - * - * @type {string} - * @memberof Station + * If the request failed, these error messages will explain why + * @type {Array} + * @memberof SimpleResponse */ - place_name: string; + errors: Array; } /** * * @export - * @interface SubmitTask + * @interface SimpleResponseItem */ -export interface SubmitTask { - /** - * - * @type {TaskTypeEnum} - * @memberof SubmitTask - */ - task_type: TaskTypeEnum; - /** - * - * @type {number} - * @memberof SubmitTask - */ - start_time: number; - /** - * - * @type {number} - * @memberof SubmitTask - */ - priority?: number; +export interface SimpleResponseItem { /** - * - * @type {CleanTaskDescription | LoopTaskDescription | DeliveryTaskDescription} - * @memberof SubmitTask + * The request was successful + * @type {boolean} + * @memberof SimpleResponseItem */ - description: CleanTaskDescription | LoopTaskDescription | DeliveryTaskDescription; + success: boolean; } /** * * @export - * @interface SubmitTaskResponse + * @interface SimpleResponseItem1 */ -export interface SubmitTaskResponse { +export interface SimpleResponseItem1 { /** - * - * @type {string} - * @memberof SubmitTaskResponse + * The request failed + * @type {boolean} + * @memberof SimpleResponseItem1 */ - task_id: string; + success: boolean; + /** + * If the request failed, these error messages will explain why + * @type {Array} + * @memberof SimpleResponseItem1 + */ + errors: Array; } /** * * @export - * @interface Task + * @interface SkipPhaseRequest */ -export interface Task { +export interface SkipPhaseRequest { /** - * - * @type {string} - * @memberof Task - */ - task_id: string; - /** - * - * @type {string} - * @memberof Task + * The time that the skip request arrived + * @type {number} + * @memberof SkipPhaseRequest */ - authz_grp?: string; + unix_millis_request_time: number; /** - * - * @type {TaskSummary} - * @memberof Task + * Labels to describe the purpose of the skip request + * @type {Array} + * @memberof SkipPhaseRequest */ - summary: TaskSummary; + labels: Array; /** - * - * @type {TaskProgress} - * @memberof Task + * Information about an undo skip request that applied to this request + * @type {Undo} + * @memberof SkipPhaseRequest */ - progress: TaskProgress; + undo?: Undo; } /** - * + * An enumeration. * @export - * @interface TaskDescription + * @enum {string} */ -export interface TaskDescription { - /** - * - * @type {Time} - * @memberof TaskDescription - */ - start_time: Time; - /** - * - * @type {Priority} - * @memberof TaskDescription - */ - priority: Priority; - /** - * - * @type {TaskType} - * @memberof TaskDescription - */ - task_type: TaskType; - /** - * - * @type {Station} - * @memberof TaskDescription - */ - station: Station; - /** - * - * @type {Loop} - * @memberof TaskDescription - */ - loop: Loop; + +export enum Status { + Uninitialized = 'uninitialized', + Offline = 'offline', + Shutdown = 'shutdown', + Idle = 'idle', + Charging = 'charging', + Working = 'working', + Error = 'error', +} + +/** + * An enumeration. + * @export + * @enum {string} + */ + +export enum Status1 { + Uninitialized = 'uninitialized', + Blocked = 'blocked', + Error = 'error', + Failed = 'failed', + Standby = 'standby', + Underway = 'underway', + Delayed = 'delayed', + Skipped = 'skipped', + Canceled = 'canceled', + Killed = 'killed', + Completed = 'completed', +} + +/** + * Response to a request to cancel a task + * @export + * @interface TaskCancelResponse + */ +export interface TaskCancelResponse { /** - * - * @type {Delivery} - * @memberof TaskDescription + * The request failed + * @type {boolean} + * @memberof TaskCancelResponse */ - delivery: Delivery; + success: boolean; /** - * - * @type {Clean} - * @memberof TaskDescription + * If the request failed, these error messages will explain why + * @type {Array} + * @memberof TaskCancelResponse */ - clean: Clean; + errors: Array; } /** * * @export - * @interface TaskProfile + * @interface TaskEventLog */ -export interface TaskProfile { +export interface TaskEventLog { /** * * @type {string} - * @memberof TaskProfile + * @memberof TaskEventLog */ task_id: string; /** - * - * @type {Time} - * @memberof TaskProfile + * Log entries related to the overall task + * @type {Array} + * @memberof TaskEventLog */ - submission_time: Time; + log?: Array; /** - * - * @type {TaskDescription} - * @memberof TaskProfile + * A dictionary whose keys (property names) are the indices of a phase + * @type {{ [key: string]: object; }} + * @memberof TaskEventLog */ - description: TaskDescription; + phases?: { [key: string]: object }; } /** * * @export - * @interface TaskProgress + * @interface TaskRequest */ -export interface TaskProgress { +export interface TaskRequest { /** - * - * @type {string} - * @memberof TaskProgress + * (Optional) The earliest time that this task may start + * @type {number} + * @memberof TaskRequest */ - status: string; + unix_millis_earliest_start_time?: number; + /** + * (Optional) The priority of this task. This must match a priority schema supported by a fleet. + * @type {object} + * @memberof TaskRequest + */ + priority?: object; + /** + * A description of the task. This must match a schema supported by a fleet. + * @type {Description} + * @memberof TaskRequest + */ + description: Description; } /** * * @export - * @interface TaskSummary + * @interface TaskState */ -export interface TaskSummary { +export interface TaskState { /** * - * @type {string} - * @memberof TaskSummary + * @type {Booking} + * @memberof TaskState */ - fleet_name: string; + booking: Booking; /** - * + * The category of this task or phase * @type {string} - * @memberof TaskSummary + * @memberof TaskState */ - task_id: string; + category?: string; /** * - * @type {TaskProfile} - * @memberof TaskSummary + * @type {Detail} + * @memberof TaskState */ - task_profile: TaskProfile; + detail?: Detail; /** * * @type {number} - * @memberof TaskSummary + * @memberof TaskState */ - state: number; + unix_millis_start_time?: number; /** * - * @type {string} - * @memberof TaskSummary + * @type {number} + * @memberof TaskState */ - status: string; + unix_millis_finish_time?: number; /** - * - * @type {Time} - * @memberof TaskSummary + * An estimate, in milliseconds, of how long the subject will take to complete + * @type {number} + * @memberof TaskState */ - submission_time: Time; + estimate_millis?: number; /** - * - * @type {Time} - * @memberof TaskSummary + * A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers. + * @type {{ [key: string]: Phase; }} + * @memberof TaskState */ - start_time: Time; + phases?: { [key: string]: Phase }; /** - * - * @type {Time} - * @memberof TaskSummary + * An array of the IDs of completed phases of this task + * @type {Array} + * @memberof TaskState */ - end_time: Time; + completed?: Array; /** - * - * @type {string} - * @memberof TaskSummary + * The ID of the active phase for this task + * @type {number} + * @memberof TaskState */ - robot_name: string; + active?: number; /** - * - * @type {string} - * @memberof TaskSummary + * An array of the pending phases of this task + * @type {Array} + * @memberof TaskState */ - authz_grp?: string; -} -/** - * - * @export - * @interface TaskType - */ -export interface TaskType { + pending?: Array; /** - * - * @type {number} - * @memberof TaskType + * A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request. + * @type {{ [key: string]: Interruption; }} + * @memberof TaskState */ - type: number; + interruptions?: { [key: string]: Interruption }; + /** + * If the task was cancelled, this will describe information about the request. + * @type {Cancellation} + * @memberof TaskState + */ + cancellation?: Cancellation; + /** + * If the task was killed, this will describe information about the request. + * @type {Killed} + * @memberof TaskState + */ + killed?: Killed; } /** * An enumeration. @@ -1628,10 +1583,11 @@ export interface TaskType { * @enum {string} */ -export enum TaskTypeEnum { - NUMBER_4 = 4, - NUMBER_1 = 1, - NUMBER_2 = 2, +export enum Tier { + Uninitialized = 'uninitialized', + Info = 'info', + Warning = 'warning', + Error = 'error', } /** @@ -1653,6 +1609,25 @@ export interface Time { */ nanosec: number; } +/** + * + * @export + * @interface Undo + */ +export interface Undo { + /** + * The time that the undo skip request arrived + * @type {number} + * @memberof Undo + */ + unix_millis_request_time: number; + /** + * Labels to describe the undo skip request + * @type {Array} + * @memberof Undo + */ + labels: Array; +} /** * * @export @@ -3294,6 +3269,38 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati ...options.headers, }; + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"description\": \"A simple token representing how the task is proceeding\", \"allOf\": [ { \"$ref\": \"#/definitions/Status1\" } ] }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"object\" } } }, \"required\": [ \"task_id\" ], \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` + * @summary Socket.io endpoint + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + lambdaSocketIoGet: async (options: any = {}): Promise => { + const localVarPath = `/socket.io`; + // 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: 'GET', ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -3334,6 +3341,18 @@ export const DefaultApiFp = function (configuration?: Configuration) { const localVarAxiosArgs = await localVarAxiosParamCreator.getUserUserGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"description\": \"A simple token representing how the task is proceeding\", \"allOf\": [ { \"$ref\": \"#/definitions/Status1\" } ] }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"object\" } } }, \"required\": [ \"task_id\" ], \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` + * @summary Socket.io endpoint + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async lambdaSocketIoGet( + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.lambdaSocketIoGet(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, }; }; @@ -3368,6 +3387,15 @@ export const DefaultApiFactory = function ( getUserUserGet(options?: any): AxiosPromise { return localVarFp.getUserUserGet(options).then((request) => request(axios, basePath)); }, + /** + * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"description\": \"A simple token representing how the task is proceeding\", \"allOf\": [ { \"$ref\": \"#/definitions/Status1\" } ] }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"object\" } } }, \"required\": [ \"task_id\" ], \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` + * @summary Socket.io endpoint + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + lambdaSocketIoGet(options?: any): AxiosPromise { + return localVarFp.lambdaSocketIoGet(options).then((request) => request(axios, basePath)); + }, }; }; @@ -3403,6 +3431,19 @@ export class DefaultApi extends BaseAPI { .getUserUserGet(options) .then((request) => request(this.axios, this.basePath)); } + + /** + * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"description\": \"A simple token representing how the task is proceeding\", \"allOf\": [ { \"$ref\": \"#/definitions/Status1\" } ] }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"object\" } } }, \"required\": [ \"task_id\" ], \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` + * @summary Socket.io endpoint + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public lambdaSocketIoGet(options?: any) { + return DefaultApiFp(this.configuration) + .lambdaSocketIoGet(options) + .then((request) => request(this.axios, this.basePath)); + } } /** @@ -4076,18 +4117,15 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio return { /** * Available in socket.io - * @summary Get Fleet State + * @summary Get Fleet Log * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFleetStateFleetsNameStateGet: async ( - name: string, - options: any = {}, - ): Promise => { + getFleetLogFleetsNameLogGet: async (name: string, options: any = {}): Promise => { // verify required parameter 'name' is not null or undefined - assertParamExists('getFleetStateFleetsNameStateGet', 'name', name); - const localVarPath = `/fleets/{name}/state`.replace( + assertParamExists('getFleetLogFleetsNameLogGet', 'name', name); + const localVarPath = `/fleets/{name}/log`.replace( `{${'name'}}`, encodeURIComponent(String(name)), ); @@ -4115,84 +4153,23 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio options: localVarRequestOptions, }; }, - /** - * - * @summary Get Fleets - * @param {string} [fleetName] comma separated list of fleet names - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getFleetsFleetsGet: async ( - fleetName?: string, - limit?: number, - offset?: number, - orderBy?: string, - options: any = {}, - ): Promise => { - const localVarPath = `/fleets`; - // 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: 'GET', ...baseOptions, ...options }; - const localVarHeaderParameter = {} as any; - const localVarQueryParameter = {} as any; - - if (fleetName !== undefined) { - localVarQueryParameter['fleet_name'] = fleetName; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (orderBy !== undefined) { - localVarQueryParameter['order_by'] = orderBy; - } - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers, - }; - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * Available in socket.io - * @summary Get Robot Health - * @param {string} fleet - * @param {string} robot + * @summary Get Fleet State + * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRobotHealthFleetsFleetRobotHealthGet: async ( - fleet: string, - robot: string, + getFleetStateFleetsNameStateGet: async ( + name: string, options: any = {}, ): Promise => { - // verify required parameter 'fleet' is not null or undefined - assertParamExists('getRobotHealthFleetsFleetRobotHealthGet', 'fleet', fleet); - // verify required parameter 'robot' is not null or undefined - assertParamExists('getRobotHealthFleetsFleetRobotHealthGet', 'robot', robot); - const localVarPath = `/fleets/{fleet}/{robot}/health` - .replace(`{${'fleet'}}`, encodeURIComponent(String(fleet))) - .replace(`{${'robot'}}`, encodeURIComponent(String(robot))); + // verify required parameter 'name' is not null or undefined + assertParamExists('getFleetStateFleetsNameStateGet', 'name', name); + const localVarPath = `/fleets/{name}/state`.replace( + `{${'name'}}`, + encodeURIComponent(String(name)), + ); // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -4219,24 +4196,22 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio }, /** * - * @summary Get Robots + * @summary Query Fleets * @param {string} [fleetName] comma separated list of fleet names - * @param {string} [robotName] comma separated list of robot names * @param {number} [limit] * @param {number} [offset] * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRobotsFleetsRobotsGet: async ( + queryFleetsFleetsGet: async ( fleetName?: string, - robotName?: string, limit?: number, offset?: number, orderBy?: string, options: any = {}, ): Promise => { - const localVarPath = `/fleets/robots`; + const localVarPath = `/fleets`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -4252,10 +4227,6 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio localVarQueryParameter['fleet_name'] = fleetName; } - if (robotName !== undefined) { - localVarQueryParameter['robot_name'] = robotName; - } - if (limit !== undefined) { localVarQueryParameter['limit'] = limit; } @@ -4293,90 +4264,57 @@ export const FleetsApiFp = function (configuration?: Configuration) { return { /** * Available in socket.io - * @summary Get Fleet State + * @summary Get Fleet Log * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFleetStateFleetsNameStateGet( + async getFleetLogFleetsNameLogGet( name: string, options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFleetStateFleetsNameStateGet( + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFleetLogFleetsNameLogGet( name, options, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * - * @summary Get Fleets - * @param {string} [fleetName] comma separated list of fleet names - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * Available in socket.io + * @summary Get Fleet State + * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFleetsFleetsGet( - fleetName?: string, - limit?: number, - offset?: number, - orderBy?: string, + async getFleetStateFleetsNameStateGet( + name: string, options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFleetsFleetsGet( - fleetName, - limit, - offset, - orderBy, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFleetStateFleetsNameStateGet( + name, options, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, - /** - * Available in socket.io - * @summary Get Robot Health - * @param {string} fleet - * @param {string} robot - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async getRobotHealthFleetsFleetRobotHealthGet( - fleet: string, - robot: string, - options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = - await localVarAxiosParamCreator.getRobotHealthFleetsFleetRobotHealthGet( - fleet, - robot, - options, - ); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, /** * - * @summary Get Robots + * @summary Query Fleets * @param {string} [fleetName] comma separated list of fleet names - * @param {string} [robotName] comma separated list of robot names * @param {number} [limit] * @param {number} [offset] * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getRobotsFleetsRobotsGet( + async queryFleetsFleetsGet( fleetName?: string, - robotName?: string, limit?: number, offset?: number, orderBy?: string, options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getRobotsFleetsRobotsGet( + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.queryFleetsFleetsGet( fleetName, - robotName, limit, offset, orderBy, @@ -4400,75 +4338,47 @@ export const FleetsApiFactory = function ( return { /** * Available in socket.io - * @summary Get Fleet State + * @summary Get Fleet Log * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFleetStateFleetsNameStateGet(name: string, options?: any): AxiosPromise { - return localVarFp - .getFleetStateFleetsNameStateGet(name, options) - .then((request) => request(axios, basePath)); - }, - /** - * - * @summary Get Fleets - * @param {string} [fleetName] comma separated list of fleet names - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - getFleetsFleetsGet( - fleetName?: string, - limit?: number, - offset?: number, - orderBy?: string, - options?: any, - ): AxiosPromise> { + getFleetLogFleetsNameLogGet(name: string, options?: any): AxiosPromise { return localVarFp - .getFleetsFleetsGet(fleetName, limit, offset, orderBy, options) + .getFleetLogFleetsNameLogGet(name, options) .then((request) => request(axios, basePath)); }, /** * Available in socket.io - * @summary Get Robot Health - * @param {string} fleet - * @param {string} robot + * @summary Get Fleet State + * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRobotHealthFleetsFleetRobotHealthGet( - fleet: string, - robot: string, - options?: any, - ): AxiosPromise { + getFleetStateFleetsNameStateGet(name: string, options?: any): AxiosPromise { return localVarFp - .getRobotHealthFleetsFleetRobotHealthGet(fleet, robot, options) + .getFleetStateFleetsNameStateGet(name, options) .then((request) => request(axios, basePath)); }, /** * - * @summary Get Robots + * @summary Query Fleets * @param {string} [fleetName] comma separated list of fleet names - * @param {string} [robotName] comma separated list of robot names * @param {number} [limit] * @param {number} [offset] * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRobotsFleetsRobotsGet( + queryFleetsFleetsGet( fleetName?: string, - robotName?: string, limit?: number, offset?: number, orderBy?: string, options?: any, - ): AxiosPromise> { + ): AxiosPromise> { return localVarFp - .getRobotsFleetsRobotsGet(fleetName, robotName, limit, offset, orderBy, options) + .queryFleetsFleetsGet(fleetName, limit, offset, orderBy, options) .then((request) => request(axios, basePath)); }, }; @@ -4480,64 +4390,39 @@ export const FleetsApiFactory = function ( * @class FleetsApi * @extends {BaseAPI} */ -export class FleetsApi extends BaseAPI { - /** - * Available in socket.io - * @summary Get Fleet State - * @param {string} name - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof FleetsApi - */ - public getFleetStateFleetsNameStateGet(name: string, options?: any) { - return FleetsApiFp(this.configuration) - .getFleetStateFleetsNameStateGet(name, options) - .then((request) => request(this.axios, this.basePath)); - } - +export class FleetsApi extends BaseAPI { /** - * - * @summary Get Fleets - * @param {string} [fleetName] comma separated list of fleet names - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * Available in socket.io + * @summary Get Fleet Log + * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FleetsApi */ - public getFleetsFleetsGet( - fleetName?: string, - limit?: number, - offset?: number, - orderBy?: string, - options?: any, - ) { + public getFleetLogFleetsNameLogGet(name: string, options?: any) { return FleetsApiFp(this.configuration) - .getFleetsFleetsGet(fleetName, limit, offset, orderBy, options) + .getFleetLogFleetsNameLogGet(name, options) .then((request) => request(this.axios, this.basePath)); } /** * Available in socket.io - * @summary Get Robot Health - * @param {string} fleet - * @param {string} robot + * @summary Get Fleet State + * @param {string} name * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FleetsApi */ - public getRobotHealthFleetsFleetRobotHealthGet(fleet: string, robot: string, options?: any) { + public getFleetStateFleetsNameStateGet(name: string, options?: any) { return FleetsApiFp(this.configuration) - .getRobotHealthFleetsFleetRobotHealthGet(fleet, robot, options) + .getFleetStateFleetsNameStateGet(name, options) .then((request) => request(this.axios, this.basePath)); } /** * - * @summary Get Robots + * @summary Query Fleets * @param {string} [fleetName] comma separated list of fleet names - * @param {string} [robotName] comma separated list of robot names * @param {number} [limit] * @param {number} [offset] * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. @@ -4545,16 +4430,15 @@ export class FleetsApi extends BaseAPI { * @throws {RequiredError} * @memberof FleetsApi */ - public getRobotsFleetsRobotsGet( + public queryFleetsFleetsGet( fleetName?: string, - robotName?: string, limit?: number, offset?: number, orderBy?: string, options?: any, ) { return FleetsApiFp(this.configuration) - .getRobotsFleetsRobotsGet(fleetName, robotName, limit, offset, orderBy, options) + .queryFleetsFleetsGet(fleetName, limit, offset, orderBy, options) .then((request) => request(this.axios, this.basePath)); } } @@ -5229,19 +5113,22 @@ export class LiftsApi extends BaseAPI { export const TasksApiAxiosParamCreator = function (configuration?: Configuration) { return { /** - * - * @summary Cancel Task - * @param {CancelTask} cancelTask + * Available in socket.io + * @summary Get Task Log + * @param {string} taskId task_id * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancelTaskTasksCancelTaskPost: async ( - cancelTask: CancelTask, + getTaskLogTasksTaskIdLogGet: async ( + taskId: string, options: any = {}, ): Promise => { - // verify required parameter 'cancelTask' is not null or undefined - assertParamExists('cancelTaskTasksCancelTaskPost', 'cancelTask', cancelTask); - const localVarPath = `/tasks/cancel_task`; + // verify required parameter 'taskId' is not null or undefined + assertParamExists('getTaskLogTasksTaskIdLogGet', 'taskId', taskId); + const localVarPath = `/tasks/{task_id}/log`.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; @@ -5249,12 +5136,10 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options }; + const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { @@ -5262,11 +5147,6 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration ...headersFromBaseOptions, ...options.headers, }; - localVarRequestOptions.data = serializeDataIfNeeded( - cancelTask, - localVarRequestOptions, - configuration, - ); return { url: toPathString(localVarUrlObj), @@ -5275,18 +5155,18 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration }, /** * Available in socket.io - * @summary Get Task Summary - * @param {string} taskId task_id with \'/\' replaced with \'__\' + * @summary Get Task State + * @param {string} taskId task_id * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTaskSummaryTasksTaskIdSummaryGet: async ( + getTaskStateTasksTaskIdStateGet: async ( taskId: string, options: any = {}, ): Promise => { // verify required parameter 'taskId' is not null or undefined - assertParamExists('getTaskSummaryTasksTaskIdSummaryGet', 'taskId', taskId); - const localVarPath = `/tasks/{task_id}/summary`.replace( + assertParamExists('getTaskStateTasksTaskIdStateGet', 'taskId', taskId); + const localVarPath = `/tasks/{task_id}/state`.replace( `{${'task_id'}}`, encodeURIComponent(String(taskId)), ); @@ -5316,38 +5196,22 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration }, /** * - * @summary Get Tasks - * @param {string} [taskId] comma separated list of task ids - * @param {string} [fleetName] comma separated list of fleet names - * @param {string} [submissionTimeSince] - * @param {string} [startTimeSince] - * @param {string} [endTimeSince] - * @param {string} [robotName] comma separated list of robot names - * @param {string} [state] comma separated list of states - * @param {string} [taskType] comma separated list of task types - * @param {number} [priority] - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * @summary Post Cancel Task + * @param {CancelTaskRequest} cancelTaskRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTasksTasksGet: async ( - taskId?: string, - fleetName?: string, - submissionTimeSince?: string, - startTimeSince?: string, - endTimeSince?: string, - robotName?: string, - state?: string, - taskType?: string, - priority?: number, - limit?: number, - offset?: number, - orderBy?: string, + postCancelTaskTasksCancelTaskPost: async ( + cancelTaskRequest: CancelTaskRequest, options: any = {}, ): Promise => { - const localVarPath = `/tasks`; + // verify required parameter 'cancelTaskRequest' is not null or undefined + assertParamExists( + 'postCancelTaskTasksCancelTaskPost', + 'cancelTaskRequest', + cancelTaskRequest, + ); + const localVarPath = `/tasks/cancel_task`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -5355,66 +5219,11 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options }; + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (taskId !== undefined) { - localVarQueryParameter['task_id'] = taskId; - } - - if (fleetName !== undefined) { - localVarQueryParameter['fleet_name'] = fleetName; - } - - if (submissionTimeSince !== undefined) { - localVarQueryParameter['submission_time_since'] = - (submissionTimeSince as any) instanceof Date - ? (submissionTimeSince as any).toISOString() - : submissionTimeSince; - } - - if (startTimeSince !== undefined) { - localVarQueryParameter['start_time_since'] = - (startTimeSince as any) instanceof Date - ? (startTimeSince as any).toISOString() - : startTimeSince; - } - - if (endTimeSince !== undefined) { - localVarQueryParameter['end_time_since'] = - (endTimeSince as any) instanceof Date - ? (endTimeSince as any).toISOString() - : endTimeSince; - } - - if (robotName !== undefined) { - localVarQueryParameter['robot_name'] = robotName; - } - - if (state !== undefined) { - localVarQueryParameter['state'] = state; - } - - if (taskType !== undefined) { - localVarQueryParameter['task_type'] = taskType; - } - - if (priority !== undefined) { - localVarQueryParameter['priority'] = priority; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (orderBy !== undefined) { - localVarQueryParameter['order_by'] = orderBy; - } + localVarHeaderParameter['Content-Type'] = 'application/json'; setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; @@ -5423,6 +5232,11 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration ...headersFromBaseOptions, ...options.headers, }; + localVarRequestOptions.data = serializeDataIfNeeded( + cancelTaskRequest, + localVarRequestOptions, + configuration, + ); return { url: toPathString(localVarUrlObj), @@ -5431,18 +5245,18 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration }, /** * - * @summary Submit Task - * @param {SubmitTask} submitTask + * @summary Post Task Request + * @param {TaskRequest} taskRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - submitTaskTasksSubmitTaskPost: async ( - submitTask: SubmitTask, + postTaskRequestTasksTaskRequestPost: async ( + taskRequest: TaskRequest, options: any = {}, ): Promise => { - // verify required parameter 'submitTask' is not null or undefined - assertParamExists('submitTaskTasksSubmitTaskPost', 'submitTask', submitTask); - const localVarPath = `/tasks/submit_task`; + // verify required parameter 'taskRequest' is not null or undefined + assertParamExists('postTaskRequestTasksTaskRequestPost', 'taskRequest', taskRequest); + const localVarPath = `/tasks/task_request`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -5464,11 +5278,89 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration ...options.headers, }; localVarRequestOptions.data = serializeDataIfNeeded( - submitTask, + taskRequest, localVarRequestOptions, configuration, ); + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Query Task States + * @param {string} [taskId] comma separated list of task ids + * @param {string} [category] comma separated list of task categories + * @param {string} [startTime] + * @param {string} [finishTime] + * @param {number} [limit] + * @param {number} [offset] + * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + queryTaskStatesTasksGet: async ( + taskId?: string, + category?: string, + startTime?: string, + finishTime?: string, + limit?: number, + offset?: number, + orderBy?: string, + options: any = {}, + ): Promise => { + const localVarPath = `/tasks`; + // 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: 'GET', ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (taskId !== undefined) { + localVarQueryParameter['task_id'] = taskId; + } + + if (category !== undefined) { + localVarQueryParameter['category'] = category; + } + + if (startTime !== undefined) { + localVarQueryParameter['start_time'] = + (startTime as any) instanceof Date ? (startTime as any).toISOString() : startTime; + } + + if (finishTime !== undefined) { + localVarQueryParameter['finish_time'] = + (finishTime as any) instanceof Date ? (finishTime as any).toISOString() : finishTime; + } + + if (limit !== undefined) { + localVarQueryParameter['limit'] = limit; + } + + if (offset !== undefined) { + localVarQueryParameter['offset'] = offset; + } + + if (orderBy !== undefined) { + localVarQueryParameter['order_by'] = orderBy; + } + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + return { url: toPathString(localVarUrlObj), options: localVarRequestOptions, @@ -5485,34 +5377,34 @@ export const TasksApiFp = function (configuration?: Configuration) { const localVarAxiosParamCreator = TasksApiAxiosParamCreator(configuration); return { /** - * - * @summary Cancel Task - * @param {CancelTask} cancelTask + * Available in socket.io + * @summary Get Task Log + * @param {string} taskId task_id * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async cancelTaskTasksCancelTaskPost( - cancelTask: CancelTask, + async getTaskLogTasksTaskIdLogGet( + taskId: string, options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cancelTaskTasksCancelTaskPost( - cancelTask, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskLogTasksTaskIdLogGet( + taskId, options, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** * Available in socket.io - * @summary Get Task Summary - * @param {string} taskId task_id with \'/\' replaced with \'__\' + * @summary Get Task State + * @param {string} taskId task_id * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getTaskSummaryTasksTaskIdSummaryGet( + async getTaskStateTasksTaskIdStateGet( taskId: string, options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskSummaryTasksTaskIdSummaryGet( + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStateTasksTaskIdStateGet( taskId, options, ); @@ -5520,47 +5412,66 @@ export const TasksApiFp = function (configuration?: Configuration) { }, /** * - * @summary Get Tasks + * @summary Post Cancel Task + * @param {CancelTaskRequest} cancelTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postCancelTaskTasksCancelTaskPost( + cancelTaskRequest: CancelTaskRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postCancelTaskTasksCancelTaskPost( + cancelTaskRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Post Task Request + * @param {TaskRequest} taskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postTaskRequestTasksTaskRequestPost( + taskRequest: TaskRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postTaskRequestTasksTaskRequestPost( + taskRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Query Task States * @param {string} [taskId] comma separated list of task ids - * @param {string} [fleetName] comma separated list of fleet names - * @param {string} [submissionTimeSince] - * @param {string} [startTimeSince] - * @param {string} [endTimeSince] - * @param {string} [robotName] comma separated list of robot names - * @param {string} [state] comma separated list of states - * @param {string} [taskType] comma separated list of task types - * @param {number} [priority] + * @param {string} [category] comma separated list of task categories + * @param {string} [startTime] + * @param {string} [finishTime] * @param {number} [limit] * @param {number} [offset] * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getTasksTasksGet( + async queryTaskStatesTasksGet( taskId?: string, - fleetName?: string, - submissionTimeSince?: string, - startTimeSince?: string, - endTimeSince?: string, - robotName?: string, - state?: string, - taskType?: string, - priority?: number, + category?: string, + startTime?: string, + finishTime?: string, limit?: number, offset?: number, orderBy?: string, options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getTasksTasksGet( + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.queryTaskStatesTasksGet( taskId, - fleetName, - submissionTimeSince, - startTimeSince, - endTimeSince, - robotName, - state, - taskType, - priority, + category, + startTime, + finishTime, limit, offset, orderBy, @@ -5568,23 +5479,6 @@ export const TasksApiFp = function (configuration?: Configuration) { ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, - /** - * - * @summary Submit Task - * @param {SubmitTask} submitTask - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async submitTaskTasksSubmitTaskPost( - submitTask: SubmitTask, - options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.submitTaskTasksSubmitTaskPost( - submitTask, - options, - ); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, }; }; @@ -5600,73 +5494,88 @@ export const TasksApiFactory = function ( const localVarFp = TasksApiFp(configuration); return { /** - * - * @summary Cancel Task - * @param {CancelTask} cancelTask + * Available in socket.io + * @summary Get Task Log + * @param {string} taskId task_id * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cancelTaskTasksCancelTaskPost(cancelTask: CancelTask, options?: any): AxiosPromise { + getTaskLogTasksTaskIdLogGet(taskId: string, options?: any): AxiosPromise { return localVarFp - .cancelTaskTasksCancelTaskPost(cancelTask, options) + .getTaskLogTasksTaskIdLogGet(taskId, options) .then((request) => request(axios, basePath)); }, /** * Available in socket.io - * @summary Get Task Summary - * @param {string} taskId task_id with \'/\' replaced with \'__\' + * @summary Get Task State + * @param {string} taskId task_id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTaskStateTasksTaskIdStateGet(taskId: string, options?: any): AxiosPromise { + return localVarFp + .getTaskStateTasksTaskIdStateGet(taskId, options) + .then((request) => request(axios, basePath)); + }, + /** + * + * @summary Post Cancel Task + * @param {CancelTaskRequest} cancelTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postCancelTaskTasksCancelTaskPost( + cancelTaskRequest: CancelTaskRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .postCancelTaskTasksCancelTaskPost(cancelTaskRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * + * @summary Post Task Request + * @param {TaskRequest} taskRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTaskSummaryTasksTaskIdSummaryGet(taskId: string, options?: any): AxiosPromise { + postTaskRequestTasksTaskRequestPost( + taskRequest: TaskRequest, + options?: any, + ): AxiosPromise { return localVarFp - .getTaskSummaryTasksTaskIdSummaryGet(taskId, options) + .postTaskRequestTasksTaskRequestPost(taskRequest, options) .then((request) => request(axios, basePath)); }, /** * - * @summary Get Tasks + * @summary Query Task States * @param {string} [taskId] comma separated list of task ids - * @param {string} [fleetName] comma separated list of fleet names - * @param {string} [submissionTimeSince] - * @param {string} [startTimeSince] - * @param {string} [endTimeSince] - * @param {string} [robotName] comma separated list of robot names - * @param {string} [state] comma separated list of states - * @param {string} [taskType] comma separated list of task types - * @param {number} [priority] + * @param {string} [category] comma separated list of task categories + * @param {string} [startTime] + * @param {string} [finishTime] * @param {number} [limit] * @param {number} [offset] * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTasksTasksGet( + queryTaskStatesTasksGet( taskId?: string, - fleetName?: string, - submissionTimeSince?: string, - startTimeSince?: string, - endTimeSince?: string, - robotName?: string, - state?: string, - taskType?: string, - priority?: number, + category?: string, + startTime?: string, + finishTime?: string, limit?: number, offset?: number, orderBy?: string, options?: any, - ): AxiosPromise> { + ): AxiosPromise> { return localVarFp - .getTasksTasksGet( + .queryTaskStatesTasksGet( taskId, - fleetName, - submissionTimeSince, - startTimeSince, - endTimeSince, - robotName, - state, - taskType, - priority, + category, + startTime, + finishTime, limit, offset, orderBy, @@ -5674,21 +5583,6 @@ export const TasksApiFactory = function ( ) .then((request) => request(axios, basePath)); }, - /** - * - * @summary Submit Task - * @param {SubmitTask} submitTask - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - submitTaskTasksSubmitTaskPost( - submitTask: SubmitTask, - options?: any, - ): AxiosPromise { - return localVarFp - .submitTaskTasksSubmitTaskPost(submitTask, options) - .then((request) => request(axios, basePath)); - }, }; }; @@ -5700,45 +5594,68 @@ export const TasksApiFactory = function ( */ export class TasksApi extends BaseAPI { /** - * - * @summary Cancel Task - * @param {CancelTask} cancelTask + * Available in socket.io + * @summary Get Task Log + * @param {string} taskId task_id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TasksApi */ - public cancelTaskTasksCancelTaskPost(cancelTask: CancelTask, options?: any) { + public getTaskLogTasksTaskIdLogGet(taskId: string, options?: any) { return TasksApiFp(this.configuration) - .cancelTaskTasksCancelTaskPost(cancelTask, options) + .getTaskLogTasksTaskIdLogGet(taskId, options) .then((request) => request(this.axios, this.basePath)); } /** * Available in socket.io - * @summary Get Task Summary - * @param {string} taskId task_id with \'/\' replaced with \'__\' + * @summary Get Task State + * @param {string} taskId task_id + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public getTaskStateTasksTaskIdStateGet(taskId: string, options?: any) { + return TasksApiFp(this.configuration) + .getTaskStateTasksTaskIdStateGet(taskId, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Post Cancel Task + * @param {CancelTaskRequest} cancelTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postCancelTaskTasksCancelTaskPost(cancelTaskRequest: CancelTaskRequest, options?: any) { + return TasksApiFp(this.configuration) + .postCancelTaskTasksCancelTaskPost(cancelTaskRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Post Task Request + * @param {TaskRequest} taskRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TasksApi */ - public getTaskSummaryTasksTaskIdSummaryGet(taskId: string, options?: any) { + public postTaskRequestTasksTaskRequestPost(taskRequest: TaskRequest, options?: any) { return TasksApiFp(this.configuration) - .getTaskSummaryTasksTaskIdSummaryGet(taskId, options) + .postTaskRequestTasksTaskRequestPost(taskRequest, options) .then((request) => request(this.axios, this.basePath)); } /** * - * @summary Get Tasks + * @summary Query Task States * @param {string} [taskId] comma separated list of task ids - * @param {string} [fleetName] comma separated list of fleet names - * @param {string} [submissionTimeSince] - * @param {string} [startTimeSince] - * @param {string} [endTimeSince] - * @param {string} [robotName] comma separated list of robot names - * @param {string} [state] comma separated list of states - * @param {string} [taskType] comma separated list of task types - * @param {number} [priority] + * @param {string} [category] comma separated list of task categories + * @param {string} [startTime] + * @param {string} [finishTime] * @param {number} [limit] * @param {number} [offset] * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. @@ -5746,32 +5663,22 @@ export class TasksApi extends BaseAPI { * @throws {RequiredError} * @memberof TasksApi */ - public getTasksTasksGet( + public queryTaskStatesTasksGet( taskId?: string, - fleetName?: string, - submissionTimeSince?: string, - startTimeSince?: string, - endTimeSince?: string, - robotName?: string, - state?: string, - taskType?: string, - priority?: number, + category?: string, + startTime?: string, + finishTime?: string, limit?: number, offset?: number, orderBy?: string, options?: any, ) { return TasksApiFp(this.configuration) - .getTasksTasksGet( + .queryTaskStatesTasksGet( taskId, - fleetName, - submissionTimeSince, - startTimeSince, - endTimeSince, - robotName, - state, - taskType, - priority, + category, + startTime, + finishTime, limit, offset, orderBy, @@ -5779,18 +5686,4 @@ export class TasksApi extends BaseAPI { ) .then((request) => request(this.axios, this.basePath)); } - - /** - * - * @summary Submit Task - * @param {SubmitTask} submitTask - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TasksApi - */ - public submitTaskTasksSubmitTaskPost(submitTask: SubmitTask, options?: any) { - return TasksApiFp(this.configuration) - .submitTaskTasksSubmitTaskPost(submitTask, options) - .then((request) => request(this.axios, this.basePath)); - } } diff --git a/packages/api-client/lib/version.ts b/packages/api-client/lib/version.ts index d2e76e189..d040689fb 100644 --- a/packages/api-client/lib/version.ts +++ b/packages/api-client/lib/version.ts @@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models'; export const version = { rmfModels: rmfModelVer, - rmfServer: 'e8f1bf61ba81bb9677a3ddd2e40deeea6502d87f', + rmfServer: 'f3e79d6fd0b185c6a098b05d3c4b9d8683ca8c28', openapiGenerator: '5.2.1', }; diff --git a/packages/api-server/api_server/__main__.py b/packages/api-server/api_server/__main__.py index 716db59bb..16ea96048 100644 --- a/packages/api-server/api_server/__main__.py +++ b/packages/api-server/api_server/__main__.py @@ -7,6 +7,7 @@ from .app import app from .app_config import app_config +from .rmf_gateway_app import app as rmf_gateway_app from .ros import ros_shutdown, ros_spin @@ -74,6 +75,18 @@ def __init__(self): ) ) + self.servers.append( + CustomServer( + uvicorn.Config( + app=rmf_gateway_app, + host=app_config.host, + port=app_config.base_port + 1, + root_path=app_config.public_url.path, + log_level=app_config.log_level.lower(), + ) + ) + ) + def run(self): for srv in self.servers: srv.config.setup_event_loop() diff --git a/packages/api-server/api_server/gateway.py b/packages/api-server/api_server/gateway.py index c5fa874b5..4c17fd3e3 100644 --- a/packages/api-server/api_server/gateway.py +++ b/packages/api-server/api_server/gateway.py @@ -4,11 +4,11 @@ import base64 import hashlib import logging -from typing import List, Optional +from typing import Any, List, Optional import rclpy -import rclpy.executors -import rclpy.node +import rclpy.client +import rclpy.qos from builtin_interfaces.msg import Time as RosTime from fastapi import HTTPException from rclpy.subscription import Subscription @@ -19,26 +19,16 @@ from rmf_door_msgs.msg import DoorMode as RmfDoorMode from rmf_door_msgs.msg import DoorRequest as RmfDoorRequest from rmf_door_msgs.msg import DoorState as RmfDoorState -from rmf_fleet_msgs.msg import FleetState as RmfFleetState from rmf_ingestor_msgs.msg import IngestorState as RmfIngestorState from rmf_lift_msgs.msg import LiftRequest as RmfLiftRequest from rmf_lift_msgs.msg import LiftState as RmfLiftState -from rmf_task_msgs.msg import Tasks as RmfTasks from rmf_task_msgs.srv import CancelTask as RmfCancelTask from rmf_task_msgs.srv import GetTaskList as RmfGetTaskList from rmf_task_msgs.srv import SubmitTask as RmfSubmitTask from rosidl_runtime_py.convert import message_to_ordereddict from .logger import logger as base_logger -from .models import ( - BuildingMap, - DispenserState, - DoorState, - FleetState, - IngestorState, - LiftState, - TaskSummary, -) +from .models import BuildingMap, DispenserState, DoorState, IngestorState, LiftState from .repositories import StaticFilesRepository, static_files_repo from .rmf_io import rmf_events from .ros import ros_node @@ -71,7 +61,10 @@ def process_building_map( class RmfGateway: def __init__( - self, static_files: StaticFilesRepository, *, logger: logging.Logger = None + self, + static_files: StaticFilesRepository, + *, + logger: logging.Logger = None, ): self._door_req = ros_node.create_publisher( RmfDoorRequest, "adapter_door_requests", 10 @@ -88,7 +81,7 @@ def __init__( self._subscriptions: List[Subscription] = [] self._loop: asyncio.AbstractEventLoop - async def call_service(self, client: rclpy.client.Client, req, timeout=1): + async def call_service(self, client: rclpy.client.Client, req, timeout=1) -> Any: """ Utility to wrap a ros service call in an awaitable, raises HTTPException if service call fails. @@ -139,25 +132,6 @@ def convert_lift_state(lift_state: RmfLiftState): ) self._subscriptions.append(ingestor_states_sub) - fleet_states_sub = ros_node.create_subscription( - RmfFleetState, - "fleet_states", - lambda msg: rmf_events.fleet_states.on_next(FleetState.from_orm(msg)), - 10, - ) - self._subscriptions.append(fleet_states_sub) - - task_summaries_sub = ros_node.create_subscription( - RmfTasks, - "dispatcher_ongoing_tasks", - lambda msg: [ - rmf_events.task_summaries.on_next(TaskSummary.from_orm(task)) - for task in msg.tasks - ], - 10, - ) - self._subscriptions.append(task_summaries_sub) - map_sub = ros_node.create_subscription( RmfBuildingMap, "map", @@ -187,22 +161,6 @@ def now() -> Optional[RosTime]: """ return ros_node.get_clock().now().to_msg() - async def get_tasks(self) -> List[TaskSummary]: - """ - Gets the list of tasks from RMF. - """ - resp: RmfGetTaskList.Response = await self.call_service( - self.get_tasks_srv, RmfGetTaskList.Request() - ) - if not resp.success: - raise HTTPException(500, "service call succeeded but RMF returned an error") - tasks: List[TaskSummary] = [] - for t in resp.active_tasks: - tasks.append(TaskSummary.from_orm(t)) - for t in resp.terminated_tasks: - tasks.append(TaskSummary.from_orm(t)) - return tasks - def request_door(self, door_name: str, mode: int) -> None: msg = RmfDoorRequest( door_name=door_name, @@ -227,15 +185,5 @@ def request_lift( ) self._lift_req.publish(msg) - async def submit_task( - self, req_msg: RmfSubmitTask.Request - ) -> RmfSubmitTask.Response: - return await self.call_service(self._submit_task_srv, req_msg) - - async def cancel_task( - self, req_msg: RmfCancelTask.Request - ) -> RmfCancelTask.Response: - return await self.call_service(self._cancel_task_srv, req_msg) - rmf_gateway = RmfGateway(static_files_repo) diff --git a/packages/api-server/api_server/models/__init__.py b/packages/api-server/api_server/models/__init__.py index ddceca20f..52583366e 100644 --- a/packages/api-server/api_server/models/__init__.py +++ b/packages/api-server/api_server/models/__init__.py @@ -7,5 +7,8 @@ from .ingestors import * from .lifts import * from .pagination import * -from .tasks import * +from .rmf_api.cancel_task_request import CancelTaskRequest +from .rmf_api.cancel_task_response import TaskCancelResponse +from .rmf_api.task_request import TaskRequest +from .tasks import TaskEventLog, TaskState from .user import * diff --git a/packages/api-server/api_server/models/fleets.py b/packages/api-server/api_server/models/fleets.py index 252d5a589..0c20225c5 100644 --- a/packages/api-server/api_server/models/fleets.py +++ b/packages/api-server/api_server/models/fleets.py @@ -1,46 +1,34 @@ -from typing import List - -from pydantic import BaseModel - -from . import tortoise_models as ttm -from .health import basic_health_model +from .rmf_api.fleet_log import FleetState as BaseFleetLog +from .rmf_api.fleet_state import FleetState as BaseFleetState from .ros_pydantic import rmf_fleet_msgs -from .tasks import Task +from .tortoise_models import FleetLog as DbFleetLog +from .tortoise_models import FleetState as DbFleetState RobotMode = rmf_fleet_msgs.RobotMode -RobotHealth = basic_health_model(ttm.RobotHealth) Location = rmf_fleet_msgs.Location -class RobotState(rmf_fleet_msgs.RobotState): +class FleetState(BaseFleetState): @staticmethod - def from_tortoise(tortoise: ttm.RobotState) -> "RobotState": - return RobotState(**tortoise.data) + def from_db(fleet_state: DbFleetState) -> "FleetState": + return FleetState(**fleet_state.data) - async def save(self, fleet_name: str) -> None: - await ttm.RobotState.update_or_create( - {"data": self.dict()}, fleet_name=fleet_name, robot_name=self.name + async def save(self) -> None: + await DbFleetState.update_or_create( + { + "data": self.json(), + }, + name=self.name, ) -class Robot(BaseModel): - fleet: str - name: str - state: RobotState - tasks: List[Task] = [] - - -class FleetState(rmf_fleet_msgs.FleetState): - robots: List[RobotState] - +class FleetLog(BaseFleetLog): @staticmethod - def from_tortoise(tortoise: ttm.FleetState) -> "FleetState": - return FleetState(**tortoise.data) + def from_db(fleet_log: DbFleetLog) -> "FleetLog": + return FleetLog(**fleet_log.data) async def save(self) -> None: - await ttm.FleetState.update_or_create({"data": self.dict()}, id_=self.name) - - -class Fleet(BaseModel): - name: str - state: FleetState + await DbFleetLog.update_or_create( + {"data": self.json()}, + name=self.name, + ) diff --git a/packages/api-server/api_server/models/tasks.py b/packages/api-server/api_server/models/tasks.py index ac37342ba..ca1a218b5 100644 --- a/packages/api-server/api_server/models/tasks.py +++ b/packages/api-server/api_server/models/tasks.py @@ -1,118 +1,37 @@ -from enum import IntEnum -from typing import Optional, Union +from datetime import datetime -from pydantic import BaseModel, validator -from rmf_task_msgs.msg import TaskSummary as RmfTaskSummary -from rmf_task_msgs.msg import TaskType as RmfTaskType +from .rmf_api.task_log import TaskEventLog as BaseTaskEventLog +from .rmf_api.task_state import TaskState as BaseTaskState +from .tortoise_models import TaskEventLog as DbTaskEventLog +from .tortoise_models import TaskState as DbTaskState -from api_server.ros_time import ros_to_py_datetime - -from . import tortoise_models as ttm -from .ros_pydantic import rmf_task_msgs - - -class TaskSummary(rmf_task_msgs.TaskSummary): - authz_grp: Optional[str] = None +class TaskState(BaseTaskState): @staticmethod - def from_tortoise(tortoise: ttm.TaskSummary) -> "TaskSummary": - return TaskSummary(authz_grp=tortoise.authz_grp, **tortoise.data) - - async def save(self, authz_grp: Optional[str] = None): - dic = self.dict() - del dic["authz_grp"] - - defaults = { - "fleet_name": self.fleet_name, - "submission_time": ros_to_py_datetime(self.submission_time), - "start_time": ros_to_py_datetime(self.start_time), - "end_time": ros_to_py_datetime(self.end_time), - "robot_name": self.robot_name, - "state": self.state, - "task_type": self.task_profile.description.task_type.type, - "priority": self.task_profile.description.priority.value, - "data": dic, - } - if authz_grp is not None: - defaults["authz_grp"] = authz_grp - await ttm.TaskSummary.update_or_create(defaults, id_=self.task_id) - - -class TaskStateEnum(IntEnum): - ACTIVE = RmfTaskSummary.STATE_ACTIVE - CANCELLED = RmfTaskSummary.STATE_CANCELED - COMPLETED = RmfTaskSummary.STATE_COMPLETED - FAILED = RmfTaskSummary.STATE_FAILED - PENDING = RmfTaskSummary.STATE_PENDING - QUEUED = RmfTaskSummary.STATE_QUEUED - - -class CleanTaskDescription(BaseModel): - cleaning_zone: str - - -class LoopTaskDescription(BaseModel): - num_loops: int - start_name: str - finish_name: str - - -class DeliveryTaskDescription(BaseModel): - pickup_place_name: str - pickup_dispenser: str - dropoff_ingestor: str - dropoff_place_name: str - - -TaskDescriptionT = Union[ - CleanTaskDescription, LoopTaskDescription, DeliveryTaskDescription -] - - -class TaskTypeEnum(IntEnum): - CLEAN = RmfTaskType.TYPE_CLEAN - LOOP = RmfTaskType.TYPE_LOOP - DELIVERY = RmfTaskType.TYPE_DELIVERY - - -class TaskProgress(BaseModel): - status: str - - -class Task(BaseModel): - task_id: str - authz_grp: Optional[str] - summary: TaskSummary - progress: TaskProgress - - -class SubmitTask(BaseModel): - task_type: TaskTypeEnum - start_time: int - priority: Optional[int] = None - description: TaskDescriptionT - - # pylint: disable=no-self-argument,no-self-use - @validator("description") - def description_matches_task_type(cls, description, values): - if not "task_type" in values: - return None - task_type: TaskTypeEnum = values["task_type"] - if task_type == TaskTypeEnum.CLEAN: - if not isinstance(description, CleanTaskDescription): - return CleanTaskDescription.validate(description) - elif task_type == TaskTypeEnum.LOOP: - if not isinstance(description, LoopTaskDescription): - raise TypeError("expected description to be LoopTaskDescription") - elif task_type == TaskTypeEnum.DELIVERY: - if not isinstance(description, DeliveryTaskDescription): - raise TypeError("expected description to be DeliveryTaskDescription") - return description - - -class SubmitTaskResponse(BaseModel): - task_id: str - - -class CancelTask(BaseModel): - task_id: str + def from_db(task_state: DbTaskState) -> "TaskState": + return TaskState(**task_state.data) + + async def save(self) -> None: + await DbTaskState.update_or_create( + { + "data": self.json(), + "category": self.category, + "unix_millis_start_time": self.unix_millis_start_time + and datetime.fromtimestamp(self.unix_millis_start_time / 1000), + "unix_millis_finish_time": self.unix_millis_finish_time + and datetime.fromtimestamp(self.unix_millis_finish_time / 1000), + }, + id_=self.booking["id"], + ) + + +class TaskEventLog(BaseTaskEventLog): + @staticmethod + def from_db(task_log: DbTaskEventLog) -> "TaskEventLog": + return TaskEventLog(**task_log.data) + + async def save(self) -> None: + await DbTaskEventLog.update_or_create( + {"data": self.json()}, + task_id=self.task_id, + ) diff --git a/packages/api-server/api_server/models/tortoise_models/__init__.py b/packages/api-server/api_server/models/tortoise_models/__init__.py index fa328d22c..7c1dda793 100644 --- a/packages/api-server/api_server/models/tortoise_models/__init__.py +++ b/packages/api-server/api_server/models/tortoise_models/__init__.py @@ -2,7 +2,7 @@ from .building_map import BuildingMap from .dispenser_state import DispenserState from .door_state import DoorState -from .fleet_state import FleetState, RobotState +from .fleets import FleetLog, FleetState from .health import ( BasicHealthModel, DispenserHealth, @@ -13,5 +13,5 @@ ) from .ingestor_state import IngestorState from .lift_state import LiftState -from .task_summary import TaskSummary +from .tasks import TaskEventLog, TaskState from .user import * diff --git a/packages/api-server/api_server/models/tortoise_models/fleet_state.py b/packages/api-server/api_server/models/tortoise_models/fleet_state.py deleted file mode 100644 index e3f758b15..000000000 --- a/packages/api-server/api_server/models/tortoise_models/fleet_state.py +++ /dev/null @@ -1,17 +0,0 @@ -from tortoise.fields.data import CharField, JSONField -from tortoise.models import Model - -from .json_mixin import JsonMixin - - -class FleetState(Model, JsonMixin): - pass - - -class RobotState(Model): - fleet_name = CharField(255) - robot_name = CharField(255) - data = JSONField() - - class Meta: - unique_together = ("fleet_name", "robot_name") diff --git a/packages/api-server/api_server/models/tortoise_models/task_summary.py b/packages/api-server/api_server/models/tortoise_models/task_summary.py deleted file mode 100644 index 986cd8bdd..000000000 --- a/packages/api-server/api_server/models/tortoise_models/task_summary.py +++ /dev/null @@ -1,23 +0,0 @@ -from rmf_task_msgs.msg import TaskSummary as RmfTaskSummary -from tortoise.fields.data import CharField, DatetimeField, IntField -from tortoise.models import Model - -from .authorization import ProtectedResource -from .json_mixin import JsonMixin - - -class TaskSummary(Model, JsonMixin, ProtectedResource): - fleet_name = CharField(255, null=True, index=True) - submission_time = DatetimeField(null=True, index=True) - start_time = DatetimeField(null=True, index=True) - end_time = DatetimeField(null=True, index=True) - robot_name = CharField(255, null=True, index=True) - state = IntField(null=True, index=True) - task_type = IntField(null=True, index=True) - priority = IntField(null=True, index=True) - - ACTIVE_STATES = [ - RmfTaskSummary.STATE_ACTIVE, - RmfTaskSummary.STATE_PENDING, - RmfTaskSummary.STATE_QUEUED, - ] diff --git a/packages/api-server/api_server/repositories/__init__.py b/packages/api-server/api_server/repositories/__init__.py index c606b88f6..c4d2a50a2 100644 --- a/packages/api-server/api_server/repositories/__init__.py +++ b/packages/api-server/api_server/repositories/__init__.py @@ -1,2 +1,4 @@ +from .fleets import FleetRepository, fleet_repo_dep from .rmf import RmfRepository, rmf_repo_dep from .static_files import StaticFilesRepository, static_files_repo +from .tasks import TaskRepository, task_repo_dep diff --git a/packages/api-server/api_server/repositories/fleets.py b/packages/api-server/api_server/repositories/fleets.py new file mode 100644 index 000000000..58b93b2ee --- /dev/null +++ b/packages/api-server/api_server/repositories/fleets.py @@ -0,0 +1,40 @@ +from typing import List, Optional + +from api_server.authenticator import user_dep +from api_server.models import FleetLog, FleetState, Pagination, User +from api_server.models.tortoise_models import FleetLog as DbFleetLog +from api_server.models.tortoise_models import FleetState as DbFleetState +from api_server.query import add_pagination +from fastapi import Depends +from tortoise.queryset import QuerySet + + +class FleetRepository: + def __init__(self, user: User): + self.user = user + + async def query_fleet_states( + self, query: QuerySet[DbFleetState], pagination: Optional[Pagination] = None + ) -> List[FleetState]: + # TODO: enforce with authz + if pagination: + query = add_pagination(query, pagination) + results = await query.values_list("data", flat=True) + return [FleetState(**r) for r in results] + + async def get_fleet_state(self, name: str) -> Optional[FleetState]: + # TODO: enforce with authz + result = await DbFleetState.get_or_none(name=name) + if result is None: + return None + return FleetState(**result.data) + + async def get_fleet_log(self, name: str) -> Optional[FleetLog]: + result = await DbFleetLog.get_or_none(name=name) + if result is None: + return None + return FleetLog(**result.data) + + +def fleet_repo_dep(user: User = Depends(user_dep)): + return FleetRepository(user) diff --git a/packages/api-server/api_server/repositories/rmf.py b/packages/api-server/api_server/repositories/rmf.py index a5ae6646e..32ff6646b 100644 --- a/packages/api-server/api_server/repositories/rmf.py +++ b/packages/api-server/api_server/repositories/rmf.py @@ -1,9 +1,4 @@ -from datetime import datetime -from typing import Dict, List, Optional, cast - -from fastapi import Depends -from fastapi.exceptions import HTTPException -from tortoise.queryset import MODEL, QuerySet +from typing import List, Optional, cast from api_server.authenticator import user_dep from api_server.models import ( @@ -14,7 +9,6 @@ Door, DoorHealth, DoorState, - FleetState, Ingestor, IngestorHealth, IngestorState, @@ -22,16 +16,11 @@ LiftHealth, LiftState, Pagination, - RobotHealth, - RobotState, - TaskStateEnum, - TaskSummary, - TaskTypeEnum, User, ) from api_server.models import tortoise_models as ttm -from api_server.models.fleets import Fleet, Robot -from api_server.permissions import Enforcer, RmfAction +from api_server.query import add_pagination +from fastapi import Depends class RmfRepository: @@ -46,31 +35,6 @@ def _build_filter_params(**queries: dict): filter_params[k] = v return filter_params - @staticmethod - def _add_pagination( - query: QuerySet[MODEL], - pagination: Pagination, - field_mappings: Dict[str, str] = None, - ) -> QuerySet[MODEL]: - """ - :param field_mapping: A dict mapping the order fields to the fields used to build the - query. e.g. a url of `?order_by=order_field` and a field mapping of `{"order_field": "db_field"}` - will order the query result according to `db_field`. - """ - field_mappings = field_mappings or {} - query = query.limit(pagination.limit).offset(pagination.offset) - if pagination.order_by is not None: - order_fields = [] - order_values = pagination.order_by.split(",") - for v in order_values: - if v[0] in ["-", "+"]: - stripped = v[1:] - order_fields.append(v[0] + field_mappings.get(stripped, stripped)) - else: - order_fields.append(field_mappings.get(v, v)) - query = query.order_by(*order_fields) - return query - async def get_bulding_map(self) -> Optional[BuildingMap]: building_map = await ttm.BuildingMap.first() if building_map is None: @@ -145,116 +109,6 @@ async def get_ingestor_health(self, guid: str) -> Optional[IngestorHealth]: return None return await IngestorHealth.from_tortoise(ingestor_health) - async def query_fleets( - self, pagination: Pagination, *, fleet_name: Optional[str] = None - ) -> List[Fleet]: - filter_params = {} - if fleet_name is not None: - filter_params["id___in"] = fleet_name.split(",") - states = await self._add_pagination( - ttm.FleetState.filter(**filter_params), pagination, {"fleet_name": "id_"} - ) - return [Fleet(name=s.id_, state=FleetState.from_tortoise(s)) for s in states] - - async def get_fleet_state(self, fleet_name: str) -> Optional[FleetState]: - fleet_state = await ttm.FleetState.get_or_none(id_=fleet_name) - if fleet_state is None: - return None - return FleetState(**fleet_state.data) - - async def query_robots( - self, - pagination: Pagination, - *, - fleet_name: Optional[str] = None, - robot_name: Optional[str] = None, - ) -> List[Robot]: - filter_params = {} - if fleet_name is not None: - filter_params["fleet_name__in"] = fleet_name.split(",") - if robot_name is not None: - filter_params["robot_name__in"] = robot_name.split(",") - - robot_states = await self._add_pagination( - ttm.RobotState.filter(**filter_params), pagination - ) - return [ - Robot(fleet=r.fleet_name, name=r.robot_name, state=cast(RobotState, r.data)) - for r in robot_states - ] - - async def get_robot_health( - self, fleet_name: str, robot_name: str - ) -> Optional[RobotHealth]: - robot_health = await ttm.RobotHealth.get_or_none( - id_=f"{fleet_name}/{robot_name}" - ) - if robot_health is None: - return None - return await RobotHealth.from_tortoise(robot_health) - - async def get_task_summary(self, task_id: str) -> TaskSummary: - # FIXME: This would fail if task_id contains "_/" - task_id = task_id.replace("__", "/") - ts = await Enforcer.query( - self.user, ttm.TaskSummary.all(), RmfAction.TaskRead - ).get_or_none(id_=task_id) - - if ts is None: - raise HTTPException(404) - return TaskSummary.from_tortoise(ts) - - async def query_task_summaries( - self, - pagination: Pagination, - *, - task_id: Optional[str] = None, - fleet_name: Optional[str] = None, - submission_time_since: Optional[datetime] = None, - start_time_since: Optional[datetime] = None, - end_time_since: Optional[datetime] = None, - robot_name: Optional[str] = None, - state: Optional[str] = None, - task_type: Optional[str] = None, - priority: Optional[int] = None, - ) -> List[TaskSummary]: - filter_params = {} - if task_id is not None: - filter_params["id___in"] = task_id.split(",") - if fleet_name is not None: - filter_params["fleet_name__in"] = fleet_name.split(",") - if submission_time_since is not None: - filter_params["submission_time__gte"] = submission_time_since - if start_time_since is not None: - filter_params["start_time__gte"] = start_time_since - if end_time_since is not None: - filter_params["end_time__gte"] = end_time_since - if robot_name is not None: - filter_params["robot_name__in"] = robot_name.split(",") - if state is not None: - try: - filter_params["state__in"] = [ - TaskStateEnum[s.upper()].value for s in state.split(",") - ] - except KeyError as e: - raise HTTPException(422, "unknown state") from e - if task_type is not None: - try: - filter_params["task_type__in"] = [ - TaskTypeEnum[t.upper()].value for t in task_type.split(",") - ] - except KeyError as e: - raise HTTPException(422, "unknown task type") from e - if priority is not None: - filter_params["priority"] = priority - - q = self._add_pagination( - ttm.TaskSummary.filter(**filter_params), pagination, {"task_id": "id_"} - ) - - tasks = await Enforcer.query(self.user, q, RmfAction.TaskRead) - return [TaskSummary.from_tortoise(t) for t in tasks] - async def query_users( self, pagination: Pagination, @@ -269,7 +123,7 @@ async def query_users( filter_params["is_admin"] = is_admin return cast( List[str], - await self._add_pagination( + await add_pagination( ttm.User.filter(**filter_params), pagination, ).values_list("username", flat=True), diff --git a/packages/api-server/api_server/repositories/tasks.py b/packages/api-server/api_server/repositories/tasks.py new file mode 100644 index 000000000..e5d808f76 --- /dev/null +++ b/packages/api-server/api_server/repositories/tasks.py @@ -0,0 +1,40 @@ +from typing import List, Optional + +from api_server.authenticator import user_dep +from api_server.models import Pagination, TaskEventLog, TaskState, User +from api_server.models.tortoise_models import TaskEventLog as DbTaskEventLog +from api_server.models.tortoise_models import TaskState as DbTaskState +from api_server.query import add_pagination +from fastapi import Depends +from tortoise.queryset import QuerySet + + +class TaskRepository: + def __init__(self, user: User): + self.user = user + + async def query_task_states( + self, query: QuerySet[DbTaskState], pagination: Optional[Pagination] = None + ) -> List[TaskState]: + if pagination: + query = add_pagination(query, pagination) + # TODO: enforce with authz + results = await query.values_list("data", flat=True) + return [TaskState(**r) for r in results] + + async def get_task_state(self, task_id: str) -> Optional[TaskState]: + # TODO: enforce with authz + result = await DbTaskState.get_or_none(id_=task_id) + if result is None: + return None + return TaskState(**result.data) + + async def get_task_log(self, task_id: str) -> Optional[TaskEventLog]: + result = await DbTaskEventLog.get_or_none(task_id=task_id) + if result is None: + return None + return TaskEventLog(**result.data) + + +def task_repo_dep(user: User = Depends(user_dep)): + return TaskRepository(user) diff --git a/packages/api-server/api_server/rmf_gateway_app.py b/packages/api-server/api_server/rmf_gateway_app.py new file mode 100644 index 000000000..0ff545e53 --- /dev/null +++ b/packages/api-server/api_server/rmf_gateway_app.py @@ -0,0 +1,88 @@ +# NOTE: This will eventually replace `gateway.py`` +import sys +from typing import Any, Dict + +from fastapi import FastAPI, WebSocket, WebSocketDisconnect + +from . import models as mdl +from .models import tortoise_models as dbmdl +from .rmf_io import fleet_events, task_events + +app = FastAPI() + + +# FIXME: Log updates are very inefficient because we are re-writing the entire logs +# on every update. More efficient solutions will require proper relational schemas. +async def process_msg(msg: Dict[str, Any]) -> None: + payload_type: str = msg["type"] + if not isinstance(payload_type, str): + print("'type' must be a string", file=sys.stderr) + + if payload_type == "task_state_update": + task_state = mdl.TaskState.construct(**msg["data"]) + await task_state.save() + task_events.task_states.on_next(task_state) + elif payload_type == "task_log_update": + task_log = mdl.TaskEventLog.construct(**msg["data"]) + current_log = mdl.TaskEventLog.from_db( + ( + await dbmdl.TaskEventLog.get_or_create( + {"data": task_log.json()}, task_id=task_log.task_id + ) + )[0] + ) + if task_log.log: + if current_log.log is None: + current_log.log = [] + current_log.log.extend(task_log.log) + if task_log.phases: + if current_log.phases is None: + current_log.phases = {} + for phase_name, phase in task_log.phases.items(): + current_phase = current_log.phases.setdefault(phase_name, {}) + if "log" in phase: + current_phase_logs = current_phase.setdefault("log", []) + current_phase_logs.extend(phase["log"]) + if "events" in phase: + current_events = current_phase.setdefault("events", {}) + for event_name, event in phase["events"].items(): + current_event = current_events.setdefault(event_name, []) + current_event.extend(event) + await current_log.save() + task_events.task_event_logs.on_next(task_log) + elif payload_type == "fleet_state_update": + fleet_state = mdl.FleetState.construct(**msg["data"]) + await fleet_state.save() + fleet_events.fleet_states.on_next(fleet_state) + elif payload_type == "fleet_log_update": + fleet_log = mdl.FleetLog.construct(**msg["data"]) + current_log = mdl.FleetLog.from_db( + ( + await dbmdl.FleetLog.get_or_create( + {"data": fleet_log.json()}, name=fleet_log.name + ) + )[0] + ) + if fleet_log.log: + if current_log.log is None: + current_log.log = [] + current_log.log.extend(fleet_log.log) + if fleet_log.robots: + if current_log.robots is None: + current_log.robots = {} + for robot_name, robot in fleet_log.robots.items(): + current_robot = current_log.robots.setdefault(robot_name, []) + current_robot.extend(robot) + await current_log.save() + fleet_events.fleet_logs.on_next(fleet_log) + + +@app.websocket("/") +async def rmf_gateway(websocket: WebSocket): + await websocket.accept() + try: + while True: + msg: Dict[str, Any] = await websocket.receive_json() + await process_msg(msg) + except WebSocketDisconnect: + pass diff --git a/packages/api-server/api_server/rmf_io/__init__.py b/packages/api-server/api_server/rmf_io/__init__.py index 0afef2440..621c0628f 100644 --- a/packages/api-server/api_server/rmf_io/__init__.py +++ b/packages/api-server/api_server/rmf_io/__init__.py @@ -1,4 +1,4 @@ from .book_keeper import RmfBookKeeper, RmfBookKeeperEvents -from .events import RmfEvents, rmf_events +from .events import RmfEvents, TaskEvents, fleet_events, rmf_events, task_events from .health_watchdog import HealthWatchdog from .topics import topics diff --git a/packages/api-server/api_server/rmf_io/book_keeper.py b/packages/api-server/api_server/rmf_io/book_keeper.py index 09fd4c5d6..ba2614d9a 100644 --- a/packages/api-server/api_server/rmf_io/book_keeper.py +++ b/packages/api-server/api_server/rmf_io/book_keeper.py @@ -4,27 +4,21 @@ from collections import namedtuple from typing import Coroutine, List -import tortoise.transactions -from rx.core.typing import Disposable -from rx.subject.subject import Subject - from api_server.models import ( BuildingMap, DispenserHealth, DispenserState, DoorHealth, DoorState, - FleetState, HealthStatus, IngestorHealth, IngestorState, LiftHealth, LiftState, - RobotHealth, - TaskSummary, ) -from api_server.models import tortoise_models as ttm from api_server.models.health import BaseBasicHealth +from rx.core.typing import Disposable +from rx.subject.subject import Subject from .events import RmfEvents @@ -105,9 +99,6 @@ async def start(self): self._record_dispenser_health() self._record_ingestor_state() self._record_ingestor_health() - self._record_fleet_state() - self._record_robot_health() - self._record_task_summary() async def stop(self): for sub in self._subscriptions: @@ -213,43 +204,3 @@ async def update(health: IngestorHealth): self._subscriptions.append( self.rmf.ingestor_health.subscribe(lambda x: self._create_task(update(x))) ) - - def _record_fleet_state(self): - async def update(fleet_state: FleetState): - tasks = [ - ttm.RobotState.update_or_create( - { - "data": r.dict(), - }, - fleet_name=fleet_state.name, - robot_name=r.name, - ) - for r in fleet_state.robots - ] - async with tortoise.transactions.in_transaction(): - await asyncio.gather(fleet_state.save(), *tasks) - - self._loggers.fleet_state.info(fleet_state.json()) - - self._subscriptions.append( - self.rmf.fleet_states.subscribe(lambda x: self._create_task(update(x))) - ) - - def _record_robot_health(self): - async def update(health: RobotHealth): - await health.save() - self._report_health(health, self._loggers.robot_health) - - self._subscriptions.append( - self.rmf.robot_health.subscribe(lambda x: self._create_task(update(x))) - ) - - def _record_task_summary(self): - async def update(summary: TaskSummary): - await summary.save() - self._loggers.task_summary.info(summary.json()) - self.bookkeeper_events.task_summary_written.on_next(summary) - - self._subscriptions.append( - self.rmf.task_summaries.subscribe(lambda x: self._create_task(update(x))) - ) diff --git a/packages/api-server/api_server/rmf_io/events.py b/packages/api-server/api_server/rmf_io/events.py index 88fcff8ac..8f52e9949 100644 --- a/packages/api-server/api_server/rmf_io/events.py +++ b/packages/api-server/api_server/rmf_io/events.py @@ -15,8 +15,25 @@ def __init__(self): self.ingestor_health = Subject() # IngestorHealth self.fleet_states = Subject() # FleetState self.robot_health = Subject() # RobotHealth - self.task_summaries = Subject() # TaskSummary self.building_map = BehaviorSubject(None) # Optional[BuildingMap] rmf_events = RmfEvents() + + +class TaskEvents: + def __init__(self): + self.task_states = Subject() # TaskState + self.task_event_logs = Subject() # TaskEventLog + + +task_events = TaskEvents() + + +class FleetEvents: + def __init__(self): + self.fleet_states = Subject() # FleetState + self.fleet_logs = Subject() # FleetLog + + +fleet_events = FleetEvents() diff --git a/packages/api-server/api_server/rmf_io/rmf_service.py b/packages/api-server/api_server/rmf_io/rmf_service.py new file mode 100644 index 000000000..ab5d4754e --- /dev/null +++ b/packages/api-server/api_server/rmf_io/rmf_service.py @@ -0,0 +1,77 @@ +import asyncio +from asyncio import Future +from typing import Dict + +import rclpy +import rclpy.node +import rclpy.qos +from api_server.logger import logger +from rmf_task_msgs.msg import ApiRequest, ApiResponse + + +class RmfService: + """ + RMF uses a pseudo service protocol implmented using pub/sub. "Calling" a service + involves publishing a request message with a request id and subscribing to a response. + + Any node can response to the request, so responses may come in out of order and there + is no guarantee that there will be only one response, clients must keep track of the + request ids which they published and drop and unknown and duplicated response ids. + """ + + API_REQUEST_TOPIC = "api_request" + API_RESPONSE_TOPIC = "api_response" + + def __init__(self, ros_node: rclpy.node.Node): + self.ros_node = ros_node + self._logger = logger.getChild(self.__class__.__name__) + self._id_counter = 0 + self._requests: Dict[str, Future] = {} + self._api_pub = self.ros_node.create_publisher( + ApiRequest, + self.API_REQUEST_TOPIC, + rclpy.qos.QoSProfile( + depth=10, + history=rclpy.qos.HistoryPolicy.KEEP_LAST, + reliability=rclpy.qos.ReliabilityPolicy.RELIABLE, + durability=rclpy.qos.DurabilityPolicy.TRANSIENT_LOCAL, + ), + ) + self._api_sub = self.ros_node.create_subscription( + ApiResponse, + self.API_RESPONSE_TOPIC, + self._handle_response, + rclpy.qos.QoSProfile( + depth=10, + history=rclpy.qos.HistoryPolicy.KEEP_LAST, + reliability=rclpy.qos.ReliabilityPolicy.RELIABLE, + durability=rclpy.qos.DurabilityPolicy.TRANSIENT_LOCAL, + ), + ) + + def destroy(self): + """ + Unsubscribes to api responses and destroys all ros objects created by this class. + """ + self._api_sub.destroy() + self._api_pub.destroy() + + async def call(self, payload: str, timeout=1) -> str: + req_id = str(self._id_counter) + self._id_counter += 1 + msg = ApiRequest(request_id=req_id, json_msg=payload) + fut = Future() + self._requests[req_id] = fut + self._api_pub.publish(msg) + resp = await asyncio.wait_for(fut, timeout) + del self._requests[req_id] + return resp + + def _handle_response(self, msg: ApiResponse): + fut = self._requests.get(msg.request_id) + if fut is None: + self._logger.warning( + f"Received response for unknown request id: {msg.request_id}" + ) + return + fut.set_result(msg.json_msg) diff --git a/packages/api-server/api_server/rmf_io/test_rmf_service.py b/packages/api-server/api_server/rmf_io/test_rmf_service.py new file mode 100644 index 000000000..590ca69ff --- /dev/null +++ b/packages/api-server/api_server/rmf_io/test_rmf_service.py @@ -0,0 +1,114 @@ +import asyncio +import threading +import time +import unittest +from uuid import uuid4 + +import rclpy +import rclpy.context +import rclpy.executors +import rclpy.node +import rclpy.qos +from rmf_task_msgs.msg import ApiRequest, ApiResponse + +from .rmf_service import RmfService + + +class TestRmfService(unittest.TestCase): + @staticmethod + def _create_node_id() -> str: + return str(uuid4()).replace("-", "_") + + def setUp(self) -> None: + self._client_context = rclpy.context.Context() + self._client_context.init() + self.client_node = rclpy.node.Node( + f"test_client{self._create_node_id()}", context=self._client_context + ) + self._client_executor = rclpy.executors.SingleThreadedExecutor() + + def client(): + while self._client_context.ok(): + rclpy.spin_once( + self.client_node, executor=self._client_executor, timeout_sec=0.1 + ) + + self._client_thread = threading.Thread(target=client) + self._client_thread.start() + + self._server_context = rclpy.context.Context() + self._server_context.init() + self.server_node = rclpy.node.Node( + f"test_server_{self._create_node_id()}", + context=self._server_context, + ) + self._server_executor = rclpy.executors.SingleThreadedExecutor() + + def server(): + pub = self.server_node.create_publisher( + ApiResponse, + RmfService.API_RESPONSE_TOPIC, + rclpy.qos.QoSProfile( + depth=10, + history=rclpy.qos.HistoryPolicy.KEEP_LAST, + reliability=rclpy.qos.ReliabilityPolicy.RELIABLE, + durability=rclpy.qos.DurabilityPolicy.TRANSIENT_LOCAL, + ), + ) + + def handle_resp(msg: ApiRequest): + pub.publish( + ApiResponse(request_id=msg.request_id, json_msg=msg.json_msg) + ) + + self.server_node.create_subscription( + ApiRequest, + RmfService.API_REQUEST_TOPIC, + handle_resp, + rclpy.qos.QoSProfile( + depth=10, + history=rclpy.qos.HistoryPolicy.KEEP_LAST, + reliability=rclpy.qos.ReliabilityPolicy.RELIABLE, + durability=rclpy.qos.DurabilityPolicy.TRANSIENT_LOCAL, + ), + ) + + while self._server_context.ok(): + rclpy.spin_once( + self.server_node, executor=self._server_executor, timeout_sec=0.1 + ) + + self._server_thread = threading.Thread(target=server) + self._server_thread.start() + + # wait for discovery + while self.server_node.get_name() not in self.client_node.get_node_names(): + time.sleep(0.1) + while self.client_node.get_name() not in self.server_node.get_node_names(): + time.sleep(0.1) + + self.rmf_service = RmfService(self.client_node) + + def tearDown(self) -> None: + self._client_context.shutdown() + self._client_executor.shutdown() + self._client_thread.join() + self._server_context.shutdown() + self._server_executor.shutdown() + self._server_thread.join() + + def test_call(self): + async def run(): + result = await self.rmf_service.call("hello") + self.assertEqual("hello", result) + + asyncio.get_event_loop().run_until_complete(run()) + + def test_multiple_calls(self): + async def run(): + tasks = [self.rmf_service.call("hello"), self.rmf_service.call("world")] + results = await asyncio.gather(*tasks) + self.assertEqual("hello", results[0]) + self.assertEqual("world", results[1]) # type: ignore (bug in pylance) + + asyncio.get_event_loop().run_until_complete(run()) diff --git a/packages/api-server/api_server/routes/fleets.py b/packages/api-server/api_server/routes/fleets.py index def813724..199a9ebe4 100644 --- a/packages/api-server/api_server/routes/fleets.py +++ b/packages/api-server/api_server/routes/fleets.py @@ -1,127 +1,70 @@ from typing import List, Optional, cast -from fastapi import Depends, Query -from rx import operators as rxops - from api_server.dependencies import pagination_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest -from api_server.gateway import rmf_gateway -from api_server.logger import logger -from api_server.models import Fleet, FleetState, Pagination, Robot, RobotHealth, Task -from api_server.repositories import RmfRepository, rmf_repo_dep -from api_server.rmf_io import rmf_events - -from .tasks.utils import get_task_progress +from api_server.models import FleetLog, FleetState, Pagination +from api_server.models.tortoise_models import FleetState as DbFleetState +from api_server.repositories import FleetRepository, fleet_repo_dep +from api_server.rmf_io import fleet_events +from fastapi import Depends, HTTPException, Query +from rx import operators as rxops router = FastIORouter(tags=["Fleets"]) - -@router.get("", response_model=List[Fleet]) -async def get_fleets( - rmf_repo: RmfRepository = Depends(rmf_repo_dep), - pagination: Pagination = Depends(pagination_query), - fleet_name: Optional[str] = Query( - None, description="comma separated list of fleet names" - ), -): - return await rmf_repo.query_fleets(pagination, fleet_name=fleet_name) +router = FastIORouter(tags=["Fleets"]) -@router.get("/robots", response_model=List[Robot]) -async def get_robots( - rmf_repo: RmfRepository = Depends(rmf_repo_dep), +@router.get("", response_model=List[FleetState]) +async def query_fleets( + repo: FleetRepository = Depends(fleet_repo_dep), pagination: Pagination = Depends(pagination_query), fleet_name: Optional[str] = Query( None, description="comma separated list of fleet names" ), - robot_name: Optional[str] = Query( - None, description="comma separated list of robot names" - ), ): - robots = { - f"{r.fleet}/{r.name}": r - for r in await rmf_repo.query_robots( - pagination, - fleet_name=fleet_name, - robot_name=robot_name, - ) - } - - filter_states = [ - "active", - "pending", - "queued", - ] - - tasks_pagination = Pagination(limit=100, offset=0, order_by="start_time") - tasks = await rmf_repo.query_task_summaries( - tasks_pagination, - fleet_name=fleet_name, - robot_name=robot_name, - state=",".join(filter_states), - ) - - for t in tasks: - r = robots.get(f"{t.fleet_name}/{t.robot_name}", None) - # This should only happen under very rare scenarios, when there are - # multiple fleets with the same robot name and there are active tasks - # assigned to those robots and the robot states are not synced to the - # tasks summaries. - if r is None: - logger.warning( - f'task "{t.task_id}" is assigned to an unknown fleet/robot ({t.fleet_name}/{t.robot_name}' - ) - continue - r.tasks.append( - Task( - task_id=t.task_id, - authz_grp=t.authz_grp, - summary=t, - progress=get_task_progress( - t, - rmf_gateway.now(), - ), - ) - ) - - return list(robots.values()) + filters = {} + if fleet_name is not None: + filters["name__in"] = fleet_name.split(",") + return await repo.query_fleet_states(DbFleetState.filter(**filters), pagination) @router.get("/{name}/state", response_model=FleetState) -async def get_fleet_state(name: str, rmf_repo: RmfRepository = Depends(rmf_repo_dep)): +async def get_fleet_state(name: str, repo: FleetRepository = Depends(fleet_repo_dep)): """ Available in socket.io """ - return await rmf_repo.get_fleet_state(name) + fleet_state = await repo.get_fleet_state(name) + if fleet_state is None: + raise HTTPException(status_code=404) + return fleet_state @router.sub("/{name}/state", response_model=FleetState) async def sub_fleet_state(req: SubscriptionRequest, name: str): user = sio_user(req) - fleet_state = await get_fleet_state(name, RmfRepository(user)) - if fleet_state is not None: - await req.sio.emit(req.room, fleet_state.dict(), req.sid) - return rmf_events.fleet_states.pipe( + fleet_state = await get_fleet_state(name, FleetRepository(user)) + await req.sio.emit(req.room, fleet_state, req.sid) + return fleet_events.fleet_states.pipe( rxops.filter(lambda x: cast(FleetState, x).name == name) ) -@router.get("/{fleet}/{robot}/health", response_model=RobotHealth) -async def get_robot_health( - fleet: str, robot: str, rmf_repo: RmfRepository = Depends(rmf_repo_dep) -): +@router.get("/{name}/log", response_model=FleetLog) +async def get_fleet_log(name: str, repo: FleetRepository = Depends(fleet_repo_dep)): """ Available in socket.io """ - return await rmf_repo.get_robot_health(fleet, robot) + fleet_log = await repo.get_fleet_log(name) + if fleet_log is None: + raise HTTPException(status_code=404) + return fleet_log -@router.sub("/{fleet}/{robot}/health", response_model=RobotHealth) -async def sub_robot_health(req: SubscriptionRequest, fleet: str, robot: str): +@router.sub("/{name}/log", response_model=FleetLog) +async def sub_fleet_log(req: SubscriptionRequest, name: str): user = sio_user(req) - health = await get_robot_health(fleet, robot, RmfRepository(user)) - if health is not None: - await req.sio.emit(req.room, health.dict(), req.sid) - return rmf_events.robot_health.pipe( - rxops.filter(lambda x: cast(RobotHealth, x).id_ == f"{fleet}/{robot}") + fleet_log = await get_fleet_log(name, FleetRepository(user)) + await req.sio.emit(req.room, fleet_log, req.sid) + return fleet_events.fleet_logs.pipe( + rxops.filter(lambda x: cast(FleetLog, x).name == name) ) diff --git a/packages/api-server/api_server/routes/tasks/dispatcher.py b/packages/api-server/api_server/routes/tasks/dispatcher.py deleted file mode 100644 index 705536680..000000000 --- a/packages/api-server/api_server/routes/tasks/dispatcher.py +++ /dev/null @@ -1,63 +0,0 @@ -from fastapi.exceptions import HTTPException -from rmf_task_msgs.srv import CancelTask as RmfCancelTask -from rmf_task_msgs.srv import SubmitTask as RmfSubmitTask - -import api_server.models as mdl -import api_server.models.tortoise_models as ttm -from api_server.gateway import RmfGateway -from api_server.permissions import Enforcer, RmfAction - - -class DispatcherClient: - def __init__(self, rmf_gateway: RmfGateway): - self.rmf_gateway = rmf_gateway - - # pylint: disable=unused-argument - @staticmethod - async def _get_submit_task_authz_grp(task: RmfSubmitTask.Request): - # TODO - return "" - - async def submit_task_request(self, user: mdl.User, req_msg: RmfSubmitTask.Request): - """ - Task Submission - This function will trigger a ros srv call to the - dispatcher node, and return a response. Function will return a Task ID. - Raises "HTTPException" if service call fails. - """ - authz_grp = await DispatcherClient._get_submit_task_authz_grp(req_msg) - if not await Enforcer.is_authorized(user, authz_grp, RmfAction.TaskSubmit): - raise HTTPException(403) - - resp = await self.rmf_gateway.submit_task(req_msg) - - await ttm.TaskSummary.update_or_create( - {"authz_grp": authz_grp, "data": {"task_id": resp.task_id}}, - id_=resp.task_id, - ) - - return resp - - # pylint: disable=unused-argument - @staticmethod - async def _get_cancel_task_authz_grp(task: mdl.CancelTask): - # TODO - return "" - - async def cancel_task_request(self, task: mdl.CancelTask, user: mdl.User) -> bool: - """ - Cancel Task - This function will trigger a ros srv call to the - dispatcher node, and return a response. - Raises "HTTPException" if service call fails. - """ - authz_grp = await DispatcherClient._get_cancel_task_authz_grp(task) - authorized = await Enforcer.is_authorized(user, authz_grp, RmfAction.TaskRead) - if not authorized: - raise HTTPException(403) - - req = RmfCancelTask.Request() - req.requester = "rmf-server" - req.task_id = task.task_id - response = await self.rmf_gateway.cancel_task(req) - if not response.success: - raise HTTPException(500, response.message) - return response.success diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index fe58ace37..fc79b0d7c 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -1,134 +1,117 @@ from datetime import datetime from typing import List, Optional, cast -from fastapi import Depends, HTTPException, Path -from fastapi.param_functions import Query -from fastapi.responses import JSONResponse -from rx import operators as rxops - from api_server.authenticator import user_dep from api_server.dependencies import pagination_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest from api_server.gateway import rmf_gateway from api_server.models import ( - CancelTask, - SubmitTask, - SubmitTaskResponse, - Task, - TaskSummary, + CancelTaskRequest, + Pagination, + TaskCancelResponse, + TaskRequest, + TaskState, User, ) -from api_server.models.pagination import Pagination -from api_server.repositories import RmfRepository, rmf_repo_dep -from api_server.rmf_io import rmf_events -from api_server.services.tasks import convert_task_request - -from .dispatcher import DispatcherClient -from .utils import get_task_progress +from api_server.models.tasks import TaskEventLog +from api_server.models.tortoise_models import TaskState as DbTaskState +from api_server.repositories import TaskRepository, task_repo_dep +from api_server.rmf_io import task_events +from fastapi import Body, Depends, HTTPException, Path, Query +from rx import operators as rxops router = FastIORouter(tags=["Tasks"]) -dispatcher_client = DispatcherClient(rmf_gateway) - -@router.get("/{task_id}/summary", response_model=TaskSummary) -async def get_task_summary( - rmf_repo: RmfRepository = Depends(rmf_repo_dep), - task_id: str = Path(..., description="task_id with '/' replaced with '__'"), +@router.get("", response_model=List[TaskState]) +async def query_task_states( + task_repo: TaskRepository = Depends(task_repo_dep), + task_id: Optional[str] = Query( + None, description="comma separated list of task ids" + ), + category: Optional[str] = Query( + None, description="comma separated list of task categories" + ), + start_time: Optional[datetime] = None, + finish_time: Optional[datetime] = None, + pagination: Pagination = Depends(pagination_query), +): + filters = {} + if task_id is not None: + filters["id___in"] = task_id.split(",") + if category is not None: + filters["category__in"] = category.split(",") + if start_time is not None: + filters["unix_millis_start_time__gte"] = start_time + if finish_time is not None: + filters["unix_millis_finish_time__gte"] = finish_time + + return await task_repo.query_task_states(DbTaskState.filter(**filters), pagination) + + +@router.get("/{task_id}/state", response_model=TaskState) +async def get_task_state( + task_repo: TaskRepository = Depends(task_repo_dep), + task_id: str = Path(..., description="task_id"), ): """ Available in socket.io """ - ts = await rmf_repo.get_task_summary(task_id) - return ts.dict(exclude_none=True) + result = await task_repo.get_task_state(task_id) + if result is None: + raise HTTPException(status_code=404) + return result -@router.sub("/{task_id}/summary", response_model=TaskSummary) -async def sub_task_summary(req: SubscriptionRequest, task_id: str): +@router.sub("/{task_id}/state", response_model=TaskState) +async def sub_task_state(req: SubscriptionRequest, task_id: str): user = sio_user(req) - try: - await req.sio.emit( - req.room, - await get_task_summary(RmfRepository(user), task_id), - req.sid, - ) - except HTTPException: - pass - return rmf_events.task_summaries.pipe( - rxops.filter(lambda x: cast(TaskSummary, x).task_id == task_id) + task_repo = TaskRepository(user) + current_state = await get_task_state(task_repo, task_id) + await req.sio.emit(req.room, current_state, req.sid) + return task_events.task_states.pipe( + rxops.filter(lambda x: cast(TaskState, x).booking.id == task_id) ) -def to_task(task_summary: TaskSummary): - return Task.construct( - task_id=task_summary.task_id, - authz_grp=task_summary.authz_grp, - progress=get_task_progress( - task_summary, - rmf_gateway.now(), - ), - summary=task_summary, - ) +@router.get("/{task_id}/log", response_model=TaskEventLog) +async def get_task_log( + task_repo: TaskRepository = Depends(task_repo_dep), + task_id: str = Path(..., description="task_id"), +): + """ + Available in socket.io + """ + result = await task_repo.get_task_log(task_id) + if result is None: + raise HTTPException(status_code=404) + return result -@router.get("", response_model=List[Task]) -async def get_tasks( - rmf_repo: RmfRepository = Depends(rmf_repo_dep), - pagination: Pagination = Depends(pagination_query), - task_id: Optional[str] = Query( - None, description="comma separated list of task ids" - ), - fleet_name: Optional[str] = Query( - None, description="comma separated list of fleet names" - ), - submission_time_since: Optional[datetime] = None, - start_time_since: Optional[datetime] = None, - end_time_since: Optional[datetime] = None, - robot_name: Optional[str] = Query( - None, description="comma separated list of robot names" - ), - state: Optional[str] = Query(None, description="comma separated list of states"), - task_type: Optional[str] = Query( - None, description="comma separated list of task types" - ), - priority: Optional[int] = None, -): - task_summaries = await rmf_repo.query_task_summaries( - pagination, - task_id=task_id, - fleet_name=fleet_name, - submission_time_since=submission_time_since, - start_time_since=start_time_since, - end_time_since=end_time_since, - robot_name=robot_name, - state=state, - task_type=task_type, - priority=priority, +@router.sub("/{task_id}/log", response_model=TaskEventLog) +async def sub_task_log(req: SubscriptionRequest, task_id: str): + user = sio_user(req) + task_repo = TaskRepository(user) + current = await get_task_log(task_repo, task_id) + await req.sio.emit(req.room, current, req.sid) + return task_events.task_event_logs.pipe( + rxops.filter(lambda x: cast(TaskEventLog, x).task_id == task_id) ) - return [to_task(t) for t in task_summaries] -@router.post("/submit_task", response_model=SubmitTaskResponse) -async def submit_task( - submit_task_params: SubmitTask, +@router.post("/task_request") +async def post_task_request( user: User = Depends(user_dep), + task_request: TaskRequest = Body(...), ): - req_msg, err_msg = convert_task_request(submit_task_params, rmf_gateway.now()) - - if err_msg: - raise HTTPException(422, err_msg) - - rmf_resp = await dispatcher_client.submit_task_request(user, req_msg) - if not rmf_resp.success: - raise HTTPException(422, rmf_resp.message) - - return {"task_id": rmf_resp.task_id} + # TODO: forward to the internal app + raise HTTPException(status_code=501) -@router.post("/cancel_task") -async def cancel_task( - task: CancelTask, +@router.post("/cancel_task", response_model=TaskCancelResponse) +async def post_cancel_task( user: User = Depends(user_dep), + cancel_request: CancelTaskRequest = Body(...), ): - cancel_status = await dispatcher_client.cancel_task_request(task, user) - return JSONResponse(content={"success": cancel_status}) + # TODO: forward to the internal app + raise HTTPException(status_code=501) diff --git a/packages/api-server/api_server/routes/tasks/test_tasks.py b/packages/api-server/api_server/routes/tasks/test_tasks.py new file mode 100644 index 000000000..f6f3d3225 --- /dev/null +++ b/packages/api-server/api_server/routes/tasks/test_tasks.py @@ -0,0 +1,49 @@ +from uuid import uuid4 + +from api_server.test import AppFixture, make_task_log, make_task_state, try_until + + +class TestTasksRoute(AppFixture): + @classmethod + def setUpClass(cls): + super().setUpClass() + task_ids = [uuid4()] + cls.task_states = [make_task_state(task_id=f"test_{x}") for x in task_ids] + cls.task_logs = [make_task_log(task_id=f"test_{x}") for x in task_ids] + + async def prepare_db(): + for t in cls.task_states: + await t.save() + for t in cls.task_logs: + await t.save() + + cls.run_in_app_loop(prepare_db()) + + def test_get_task_state(self): + resp = self.session.get(f"/tasks/{self.task_states[0].booking.id}/state") + self.assertEqual(200, resp.status_code) + self.assertEqual(self.task_states[0].booking.id, resp.json()["booking"]["id"]) + + def test_query_task_states(self): + resp = self.session.get(f"/tasks?task_id={self.task_states[0].booking.id}") + self.assertEqual(200, resp.status_code) + results = resp.json() + self.assertEqual(1, len(results)) + self.assertEqual(self.task_states[0].booking.id, results[0]["booking"]["id"]) + + def test_sub_task_state(self): + fut = self.subscribe_sio(f"/tasks/{self.task_states[0].booking.id}/state") + try_until(fut.done, lambda x: x) + result = fut.result(0) + self.assertEqual(self.task_states[0].booking.id, result["booking"]["id"]) + + def test_get_task_log(self): + resp = self.session.get(f"/tasks/{self.task_logs[0].task_id}/log") + self.assertEqual(200, resp.status_code) + self.assertEqual(self.task_logs[0].task_id, resp.json()["task_id"]) + + def test_sub_task_log(self): + fut = self.subscribe_sio(f"/tasks/{self.task_logs[0].task_id}/log") + try_until(fut.done, lambda x: x) + result = fut.result(0) + self.assertEqual(self.task_logs[0].task_id, result["task_id"]) diff --git a/packages/api-server/api_server/routes/tasks/utils.py b/packages/api-server/api_server/routes/tasks/utils.py deleted file mode 100644 index 951a7ab82..000000000 --- a/packages/api-server/api_server/routes/tasks/utils.py +++ /dev/null @@ -1,27 +0,0 @@ -from builtin_interfaces.msg import Time as RosTime -from rmf_task_msgs.msg import TaskSummary as RmfTaskSummary - -from api_server.models import TaskProgress, TaskSummary - - -def get_task_progress(task_summary: TaskSummary, now: RosTime) -> TaskProgress: - """ - convert rmf task summary msg to a task - """ - # Generate a progress percentage - duration = abs(task_summary.end_time.sec - task_summary.start_time.sec) - # check if is completed - if task_summary.state == RmfTaskSummary.STATE_COMPLETED: - progress = "100%" - # check if it state is queued/cancelled - elif duration == 0 or (task_summary.state in [0, 4]): - progress = "0%" - else: - percent = int(100 * (now.sec - task_summary.start_time.sec) / float(duration)) - if percent < 0: - progress = "0%" - elif percent > 100: - progress = "Delayed" - else: - progress = f"{percent}%" - return TaskProgress(status=progress) diff --git a/packages/api-server/api_server/routes/test_fleets.py b/packages/api-server/api_server/routes/test_fleets.py index 62fa9311d..6c0e13799 100644 --- a/packages/api-server/api_server/routes/test_fleets.py +++ b/packages/api-server/api_server/routes/test_fleets.py @@ -1,79 +1,51 @@ from uuid import uuid4 -from rmf_task_msgs.msg import TaskSummary as RmfTaskSummary - -from api_server.models import FleetState, RobotState, TaskSummary -from api_server.rmf_io import rmf_events -from api_server.test import AppFixture, try_until +from api_server.test import AppFixture, make_fleet_log, make_fleet_state, try_until class TestFleetsRoute(AppFixture): @classmethod def setUpClass(cls): super().setUpClass() - cls.fleets = [f"fleet_{uuid4()}", f"fleet_{uuid4()}"] - fleet_states = [ - FleetState( - name=cls.fleets[0], - robots=[RobotState(name="robot_1"), RobotState(name="robot_2")], - ), - FleetState( - name=cls.fleets[1], - robots=[RobotState(name="robot_3")], - ), - ] - tasks = [ - TaskSummary( - task_id=f"task_{uuid4()}", - fleet_name=cls.fleets[0], - robot_name="robot_1", - state=RmfTaskSummary.STATE_ACTIVE, - ), - TaskSummary( - task_id=f"task_{uuid4()}", - fleet_name=cls.fleets[0], - robot_name="robot_1", - state=RmfTaskSummary.STATE_PENDING, - ), - ] + names = [uuid4() for _ in range(2)] + cls.fleet_states = [make_fleet_state(f"test_{x}") for x in names] + cls.fleet_logs = [make_fleet_log(f"test_{x}") for x in names] - for f in fleet_states: - rmf_events.fleet_states.on_next(f) - for t in tasks: - rmf_events.task_summaries.on_next(t) + async def prepare_db(): + for x in cls.fleet_states: + await x.save() + for x in cls.fleet_logs: + await x.save() - def test_get_fleets(self): - resp = try_until( - lambda: self.session.get(f"/fleets?fleet_name={self.fleets[0]}"), - lambda x: x.status_code == 200 and len(x.json()) == 1, - ) - self.assertEqual(200, resp.status_code) - resp_json = resp.json() - self.assertEqual(len(resp_json), 1) + cls.run_in_app_loop(prepare_db()) - def test_get_robots(self): - resp = try_until( - lambda: self.session.get( - f"/fleets/robots?fleet_name={self.fleets[0]}&robot_name=robot_1" - ), - lambda x: x.status_code == 200 and len(x.json()) == 1, - ) + def test_query_fleets(self): + resp = self.session.get(f"/fleets?fleet_name={self.fleet_states[0].name}") self.assertEqual(200, resp.status_code) resp_json = resp.json() self.assertEqual(len(resp_json), 1) - self.assertEqual(len(resp_json[0]["tasks"]), 2) + self.assertEqual(self.fleet_states[0].name, resp_json[0]["name"]) def test_get_fleet_state(self): - resp = try_until( - lambda: self.session.get(f"/fleets/{self.fleets[0]}/state"), - lambda x: x.status_code == 200, - ) + resp = self.session.get(f"/fleets/{self.fleet_states[0].name}/state") self.assertEqual(200, resp.status_code) state = resp.json() - self.assertEqual(self.fleets[0], state["name"]) + self.assertEqual(self.fleet_states[0].name, state["name"]) def test_sub_fleet_state(self): - fut = self.subscribe_sio(f"/fleets/{self.fleets[0]}/state") + fut = self.subscribe_sio(f"/fleets/{self.fleet_states[0].name}/state") + try_until(fut.done, lambda x: x) + result = fut.result(0) + self.assertEqual(self.fleet_states[0].name, result["name"]) + + def test_get_fleet_log(self): + resp = self.session.get(f"/fleets/{self.fleet_states[0].name}/log") + self.assertEqual(200, resp.status_code) + state = resp.json() + self.assertEqual(self.fleet_logs[0].name, state["name"]) + + def test_sub_fleet_log(self): + fut = self.subscribe_sio(f"/fleets/{self.fleet_states[0].name}/log") try_until(fut.done, lambda x: x) result = fut.result(0) - self.assertEqual(self.fleets[0], result["name"]) + self.assertEqual(self.fleet_logs[0].name, result["name"]) diff --git a/packages/api-server/api_server/services/tasks.py b/packages/api-server/api_server/services/tasks.py deleted file mode 100644 index baaedd918..000000000 --- a/packages/api-server/api_server/services/tasks.py +++ /dev/null @@ -1,70 +0,0 @@ -from typing import cast - -from builtin_interfaces.msg import Time as RosTime -from fastapi import HTTPException -from rmf_task_msgs.msg import Delivery as RmfDelivery -from rmf_task_msgs.msg import Loop as RmfLoop -from rmf_task_msgs.msg import TaskType as RmfTaskType -from rmf_task_msgs.srv import SubmitTask as RmfSubmitTask - -from api_server.models import ( - CleanTaskDescription, - DeliveryTaskDescription, - LoopTaskDescription, - SubmitTask, - TaskTypeEnum, -) -from api_server.models import tortoise_models as ttm -from api_server.ros_time import convert_to_rmf_time - - -def convert_task_request(task_request: SubmitTask, now: RosTime): - """ - :param (obj) task_json: - :return req_msgs, error_msg - This is to convert a json task req format to a rmf_task_msgs - task_profile format. add this accordingly when a new msg field - is introduced. - The 'start time' here is refered to the "Duration" from now. - """ - - # NOTE: task request should already be validated by pydantic - req_msg = RmfSubmitTask.Request() - req_msg.requester = "rmf_server" # TODO: Set this as the user id - if task_request.priority is not None: - req_msg.description.priority.value = task_request.priority - - if task_request.task_type == TaskTypeEnum.CLEAN: - clean_desc = cast(CleanTaskDescription, task_request.description) - req_msg.description.task_type.type = RmfTaskType.TYPE_CLEAN - req_msg.description.clean.start_waypoint = clean_desc.cleaning_zone - elif task_request.task_type == TaskTypeEnum.LOOP: - loop_desc = cast(LoopTaskDescription, task_request.description) - req_msg.description.task_type.type = RmfTaskType.TYPE_LOOP - loop = RmfLoop() - loop.num_loops = loop_desc.num_loops - loop.start_name = loop_desc.start_name - loop.finish_name = loop_desc.finish_name - req_msg.description.loop = loop - elif task_request.task_type == TaskTypeEnum.DELIVERY: - delivery_desc = cast(DeliveryTaskDescription, task_request.description) - req_msg.description.task_type.type = RmfTaskType.TYPE_DELIVERY - delivery = RmfDelivery() - delivery.pickup_place_name = delivery_desc.pickup_place_name - delivery.pickup_dispenser = delivery_desc.pickup_dispenser - delivery.dropoff_ingestor = delivery_desc.dropoff_ingestor - delivery.dropoff_place_name = delivery_desc.dropoff_place_name - req_msg.description.delivery = delivery - else: - return None, "Invalid TaskType" - - rmf_start_time = convert_to_rmf_time(task_request.start_time, now) - req_msg.description.start_time = rmf_start_time - return req_msg, "" - - -async def get_db_task(task_id: str) -> ttm.TaskSummary: - task = await ttm.TaskSummary.get_or_none(id_=task_id) - if task is None: - raise HTTPException(404) - return task diff --git a/packages/api-server/api_server/services/test_tasks.py b/packages/api-server/api_server/services/test_tasks.py deleted file mode 100644 index 349481a15..000000000 --- a/packages/api-server/api_server/services/test_tasks.py +++ /dev/null @@ -1,51 +0,0 @@ -import unittest - -from builtin_interfaces.msg import Time as RosTime -from rmf_task_msgs.msg import TaskType as RmfTaskType - -from api_server.models import ( - CleanTaskDescription, - DeliveryTaskDescription, - LoopTaskDescription, - SubmitTask, -) - -from .tasks import convert_task_request - - -class TestDispatcherClient(unittest.TestCase): - def test_convert_task_request(self): - now = RosTime(sec=0, nanosec=0) - task = SubmitTask( - task_type=RmfTaskType.TYPE_CLEAN, - start_time=0, - description=CleanTaskDescription(cleaning_zone="zone_2"), - ) - result, err = convert_task_request(task, now) - self.assertEqual(err, "") - self.assertIsNotNone(result) - - task = SubmitTask( - task_type=RmfTaskType.TYPE_LOOP, - start_time=0, - description=LoopTaskDescription( - num_loops=1, start_name="start", finish_name="finish" - ), - ) - result, err = convert_task_request(task, now) - self.assertEqual(err, "") - self.assertIsNotNone(result) - - task = SubmitTask( - task_type=RmfTaskType.TYPE_DELIVERY, - start_time=0, - description=DeliveryTaskDescription( - pickup_place_name="coe", - pickup_dispenser="coke_dispenser", - dropoff_ingestor="coke_ingestor", - dropoff_place_name="supplies", - ), - ) - result, err = convert_task_request(task, now) - self.assertEqual(err, "") - self.assertIsNotNone(result) diff --git a/packages/api-server/api_server/test/test_data.py b/packages/api-server/api_server/test/test_data.py index 4a4e5de22..84390d800 100644 --- a/packages/api-server/api_server/test/test_data.py +++ b/packages/api-server/api_server/test/test_data.py @@ -1,10 +1,4 @@ -from rmf_building_map_msgs.msg import Door as RmfDoor -from rmf_dispenser_msgs.msg import DispenserState as RmfDispenserState -from rmf_door_msgs.msg import DoorMode as RmfDoorMode -from rmf_fleet_msgs.msg import RobotMode as RmfRobotMode -from rmf_ingestor_msgs.msg import IngestorState as RmfIngestorState -from rmf_lift_msgs.msg import LiftState as RmfLiftState -from rmf_task_msgs.msg import TaskSummary as RmfTaskSummary +import json from api_server.models import ( AffineImage, @@ -13,15 +7,20 @@ Door, DoorMode, DoorState, + FleetLog, FleetState, IngestorState, Level, Lift, LiftState, - RobotMode, - RobotState, - TaskSummary, + TaskEventLog, + TaskState, ) +from rmf_building_map_msgs.msg import Door as RmfDoor +from rmf_dispenser_msgs.msg import DispenserState as RmfDispenserState +from rmf_door_msgs.msg import DoorMode as RmfDoorMode +from rmf_ingestor_msgs.msg import IngestorState as RmfIngestorState +from rmf_lift_msgs.msg import LiftState as RmfLiftState def make_door(name: str = "test_door") -> Door: @@ -98,27 +97,565 @@ def make_ingestor_state(guid: str = "test_ingestor") -> IngestorState: ) -def make_robot_state(name: str = "test_robot") -> RobotState: - return RobotState( - name=name, - model="test_model", - task_id="", - seq=0, - mode=RobotMode(mode=RmfRobotMode.MODE_IDLE), - battery_percent=0.0, - path=[], - ) +def make_fleet_state(name: str = "test_fleet") -> FleetState: + return FleetState(name=name, robots=[]) -def make_fleet_state(name: str = "test_fleet") -> FleetState: - return FleetState( - name=name, - robots=[make_robot_state()], +def make_fleet_log(name: str = "test_fleet") -> FleetLog: + return FleetLog(name=name) + + +def make_task_state(task_id: str = "test_task") -> TaskState: + # from https://raw.githubusercontent.com/open-rmf/rmf_api_msgs/960b286d9849fc716a3043b8e1f5fb341bdf5778/rmf_api_msgs/samples/task_state/multi_dropoff_delivery.json + sample_task = json.loads( + """ +{ + "booking": { + "id": "delivery_2021:11:08:23:50", + "unix_millis_earliest_start_time": 1636388400000, + "priority": "none", + "automatic": false + }, + "category": "Multi-Delivery", + "detail": [ + { + "category": "Pick Up", + "params": { + "location": "Kitchen", + "items": [ + { + "type": "soda", + "quantity": 1 + }, + { + "type": "water", + "quantity": 1 + } + ] + } + }, + { + "category": "Drop Off", + "params": { + "location": "room_203", + "items": [ + { + "type": "soda", + "quantity": 1 + } + ] + } + }, + { + "category": "Drop Off", + "params": { + "location": "room_521", + "items": [ + { + "type": "water", + "quantity": 1 + } + ] + } + } + ], + "unix_millis_start_time": 1636388410000, + "estimate_millis": 2000000, + "phases": { + "1": { + "id": 1, + "category": "Pick Up", + "detail": { + "location": "Kitchen", + "items": [ + { + "type": "soda", + "quantity": 1 + }, + { + "type": "water", + "quantity": 1 + } + ] + }, + "estimate_millis": 600000, + "final_event_id": 0, + "events": { + "0": { + "id": 0, + "status": "completed", + "name": "Pick Up Sequence", + "detail": "", + "deps": [1, 2] + }, + "1": { + "id": 1, + "status": "completed", + "name": "Go to [place:kitchen]", + "detail": "", + "deps": [3, 4, 8] + }, + "2": { + "id": 2, + "status": "completed", + "name": "Receive items", + "detail": [ + { + "type": "soda", + "quantity": 1 + }, + { + "type": "water", + "quantity": 1 + } + ], + "deps": [] + }, + "3": { + "id": 3, + "status": "completed", + "name": "Move to [place:kitchen_door_exterior]", + "detail": "", + "deps": [] + }, + "4": { + "id": 4, + "status": "completed", + "name": "Pass through [door:kitchen_door]", + "detail": "", + "deps": [5, 6, 7] + }, + "5": { + "id": 5, + "status": "completed", + "name": "Wait for [door:kitchen_door] to open", + "detail": "", + "deps": [] + }, + "6": { + "id": 6, + "status": "completed", + "name": "Move to [place:kitchen_door_interior]", + "detail": "", + "deps": [] + }, + "7": { + "id": 7, + "status": "completed", + "name": "Wait for [door:kitchen_door] to close", + "detail": "", + "deps": [] + }, + "8": { + "id": 8, + "status": "completed", + "name": "Move to [place:kitchen]", + "detail": "", + "deps": [] + } + } + }, + "2": { + "id": 2, + "category": "Drop Off", + "detail": { + "location": "room_203", + "items": [ + { + "type": "soda", + "quantity": 1 + } + ] + }, + "estimate_millis": 720000, + "final_event_id": 0, + "events": { + "0": { + "id": 0, + "status": "underway", + "name": "Drop Off Sequence", + "detail": "", + "deps": [1, 2] + }, + "1": { + "id": 1, + "status": "underway", + "name": "Go to [place:room_203]", + "detail": "", + "deps": [3, 4, 8, 9, 14] + }, + "2": { + "id": 2, + "status": "standby", + "name": "Unload items", + "detail": [ + { + "type": "soda", + "quantity": 1 + } + ], + "deps": [] + }, + "3": { + "id": 3, + "status": "completed", + "name": "Move to [place:kitchen_door_interior]", + "detail": "", + "deps": [] + }, + "4": { + "id": 4, + "status": "underway", + "name": "Pass through [door:kitchen_door]", + "detail": "", + "deps": [5, 6, 7] + }, + "5": { + "id": 5, + "status": "underway", + "name": "Wait for [door:kitchen_door] to open", + "detail": "", + "deps": [] + }, + "6": { + "id": 6, + "status": "standby", + "name": "Move to [place:kitchen_door_exterior]", + "detail": "", + "deps": [] + }, + "7": { + "id": 7, + "status": "standby", + "name": "Wait for [door:kitchen_door] to close", + "detail": "", + "deps": [] + }, + "8": { + "id": 8, + "status": "standby", + "name": "Move to [place:lift_lobby_05_floor_B1]", + "detail": "", + "deps": [] + }, + "9": { + "id": 9, + "status": "standby", + "name": "Take [lift:lift_05_03] to [place:lift_lobby_05_floor_L2]", + "detail": "", + "deps": [10, 11, 12, 13] + }, + "10": { + "id": 10, + "status": "underway", + "name": "Wait for lift", + "detail": "Currently assigned [lift:lift_05_03]", + "deps": [] + }, + "11": { + "id": 11, + "status": "standby", + "name": "Move to [place:lift_05_03_floor_B1]", + "detail": "", + "deps": [] + }, + "12": { + "id": 12, + "status": "standby", + "name": "Lift [lift:lift_05_03] to [place:lift_05_03_floor_2]", + "detail": "", + "deps": [] + }, + "13": { + "id": 13, + "status": "standby", + "name": "Wait for [lift:lift_05_03] to open", + "detail": "", + "deps": [] + }, + "14": { + "id": 14, + "status": "standby", + "name": "Move to [place:room_203]", + "detail": "", + "deps": [] + } + } + }, + "3": { + "id": 3, + "category": "Drop Off", + "detail": { + "location": "room_521", + "items": [ + { + "type": "water", + "quantity": 1 + } + ] + }, + "estimate_millis": 680000 + } + }, + "completed": [ 1 ], + "active": 2, + "pending": [ 3 ] +} + """ ) + sample_task["booking"]["id"] = task_id + return TaskState(**sample_task) -def make_task_summary(task_id: str = "test_task") -> TaskSummary: - return TaskSummary( - task_id=task_id, - state=RmfTaskSummary.STATE_ACTIVE, +def make_task_log(task_id: str) -> TaskEventLog: + sample = TaskEventLog.construct( + **json.loads( + """ +{ + "task_id": "delivery_2021:11:08:23:50", + "log": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388410000, + "text": "Beginning task" + } + ], + "phases": { + "1": { + "log": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388410000, + "text": "Beginning phase" + } + ], + "events": { + "1": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388409995, + "text": "Generating plan to get from [place:parking_03] to [place:kitchen]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388409996, + "text": "Finished generating plan to get from [place:parking_03] to [place:kitchen]" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388414500, + "text": "Finished: Move to [place:kitchen_door_exterior]" + }, + { + "seq": 3, + "tier": "info", + "unix_millis_time": 1636388415000, + "text": "Finished: Wait for [door:kitchen_door] to open" + }, + { + "seq": 4, + "tier": "info", + "unix_millis_time": 1636388418001, + "text": "Finished: Move to [place:kitchen_door_interior]" + }, + { + "seq": 5, + "tier": "info", + "unix_millis_time": 1636388419111, + "text": "Finished: Wait for [door:kitchen_door] to close" + }, + { + "seq": 6, + "tier": "info", + "unix_millis_time": 1636388421121, + "text": "Finished: Move to [place:kitchen]" + } + ], + "2": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388421421, + "text": "Requested [item:soda], [item:water]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388421521, + "text": "Request acknowledged" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388430000, + "text": "Received [item:soda]" + }, + { + "seq": 3, + "tier": "info", + "unix_millis_time": 1636388440000, + "text": "Received [item:water]" + } + ], + "3": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388410000, + "text": "Moving towards [place:kitchen_door_exterior] from [place:parking_03]" + }, + { + "seq": 1, + "tier": "warning", + "unix_millis_time": 1636388411000, + "text": "Delayed by obstacle blocking [robot:deliverbot_01]" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388414500, + "text": "Arrived at [place:kitchen_door_exterior]" + } + ], + "5": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388414500, + "text": "Requested [door:kitchen_door] to open" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388414600, + "text": "[door:kitchen_door] acknowledged request" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388415000, + "text": "[door:kitchen_door] has opened" + } + ], + "6": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388415010, + "text": "Moving towards [place:kitchen_door_interior] from [place:kitchen_door_exterior]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388418000, + "text": "Arrived at [place:kitchen_door_interior]" + } + ], + "7": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388418010, + "text": "Requested [door:kitchen_door] to close" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388418110, + "text": "[door:kitchen_door] acknowledged request" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388419110, + "text": "[door:kitchen] has closed" + } + ], + "8": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388419120, + "text": "Moving towards [place:kitchen] from [place:kitchen_door_interior]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388421120, + "text": "Arrived at [place:kitchen]" + } + ] + } + }, + "2": { + "log": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388444500, + "text": "Beginning phase" + } + ], + "events": { + "1": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388440000, + "text": "Generating plan to get from [place:kitchen] to [place:room_203]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388440010, + "text": "Finished generating plan to get from [place:kitchen_03] to [place:room_203]" + }, + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388450000, + "text": "Finished: Move to [place:kitchen_door_interior]" + } + ], + "3": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388440010, + "text": "Moving towards [place:kitchen_door_interior] from [place:kitchen]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388450000, + "text": "Arrived at [place:kitchen_door_interior]" + } + ], + "5": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388450010, + "text": "Requested [door:kitchen_door] to open" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388450110, + "text": "[door:kitchen_door] acknowledged request" + } + ] + } + } + } +} + """ + ) ) + sample.task_id = task_id + return sample diff --git a/packages/api-server/api_server/test_rmf_gateway_app.py b/packages/api-server/api_server/test_rmf_gateway_app.py new file mode 100644 index 000000000..7402c35bd --- /dev/null +++ b/packages/api-server/api_server/test_rmf_gateway_app.py @@ -0,0 +1,37 @@ +# NOTE: This will eventually replace `gateway.py`` +from uuid import uuid4 + +import websocket +from fastapi import FastAPI + +from .app_config import app_config +from .models.rmf_api.task_log_update import TaskEventLogUpdate +from .test import AppFixture, make_task_log, try_until + +app = FastAPI() + + +class TestRmfGatewayApp(AppFixture): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.ws = websocket.WebSocket() + cls.ws.connect(f"ws://{app_config.host}:{app_config.base_port + 1}") + + @classmethod + def tearDownClass(cls): + cls.ws.close() + super().tearDownClass() + + def test_task_log_update(self): + task_log = make_task_log(uuid4().hex) + task_log_update = TaskEventLogUpdate.construct( + type="task_log_update", data=task_log + ) + self.ws.send(task_log_update.json()) + resp = try_until( + lambda: self.session.get(f"/tasks/{task_log.task_id}/log"), + lambda x: x.status_code == 200, + ) + self.assertEqual(200, resp.status_code) + self.assertEqual(task_log.task_id, resp.json()["task_id"]) From 91809f1a91a3e3912d820a408f6384cdaecd1749 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Tue, 4 Jan 2022 02:51:35 +0000 Subject: [PATCH 02/79] fix tests Signed-off-by: Teo Koon Peng --- .../api-server/api_server/models/tasks.py | 2 +- .../api_server/rmf_io/test_rmf_service.py | 66 ++++++++++--------- 2 files changed, 35 insertions(+), 33 deletions(-) diff --git a/packages/api-server/api_server/models/tasks.py b/packages/api-server/api_server/models/tasks.py index ca1a218b5..2889cc211 100644 --- a/packages/api-server/api_server/models/tasks.py +++ b/packages/api-server/api_server/models/tasks.py @@ -21,7 +21,7 @@ async def save(self) -> None: "unix_millis_finish_time": self.unix_millis_finish_time and datetime.fromtimestamp(self.unix_millis_finish_time / 1000), }, - id_=self.booking["id"], + id_=self.booking.id, ) diff --git a/packages/api-server/api_server/rmf_io/test_rmf_service.py b/packages/api-server/api_server/rmf_io/test_rmf_service.py index 590ca69ff..c998471bc 100644 --- a/packages/api-server/api_server/rmf_io/test_rmf_service.py +++ b/packages/api-server/api_server/rmf_io/test_rmf_service.py @@ -19,33 +19,34 @@ class TestRmfService(unittest.TestCase): def _create_node_id() -> str: return str(uuid4()).replace("-", "_") - def setUp(self) -> None: - self._client_context = rclpy.context.Context() - self._client_context.init() - self.client_node = rclpy.node.Node( - f"test_client{self._create_node_id()}", context=self._client_context + @classmethod + def setUpClass(cls) -> None: + cls._client_context = rclpy.context.Context() + cls._client_context.init() + cls.client_node = rclpy.node.Node( + f"test_client{cls._create_node_id()}", context=cls._client_context ) - self._client_executor = rclpy.executors.SingleThreadedExecutor() + cls._client_executor = rclpy.executors.SingleThreadedExecutor() def client(): - while self._client_context.ok(): + while cls._client_context.ok(): rclpy.spin_once( - self.client_node, executor=self._client_executor, timeout_sec=0.1 + cls.client_node, executor=cls._client_executor, timeout_sec=0.1 ) - self._client_thread = threading.Thread(target=client) - self._client_thread.start() + cls._client_thread = threading.Thread(target=client) + cls._client_thread.start() - self._server_context = rclpy.context.Context() - self._server_context.init() - self.server_node = rclpy.node.Node( - f"test_server_{self._create_node_id()}", - context=self._server_context, + cls._server_context = rclpy.context.Context() + cls._server_context.init() + cls.server_node = rclpy.node.Node( + f"test_server_{cls._create_node_id()}", + context=cls._server_context, ) - self._server_executor = rclpy.executors.SingleThreadedExecutor() + cls._server_executor = rclpy.executors.SingleThreadedExecutor() def server(): - pub = self.server_node.create_publisher( + pub = cls.server_node.create_publisher( ApiResponse, RmfService.API_RESPONSE_TOPIC, rclpy.qos.QoSProfile( @@ -61,7 +62,7 @@ def handle_resp(msg: ApiRequest): ApiResponse(request_id=msg.request_id, json_msg=msg.json_msg) ) - self.server_node.create_subscription( + cls.server_node.create_subscription( ApiRequest, RmfService.API_REQUEST_TOPIC, handle_resp, @@ -73,29 +74,30 @@ def handle_resp(msg: ApiRequest): ), ) - while self._server_context.ok(): + while cls._server_context.ok(): rclpy.spin_once( - self.server_node, executor=self._server_executor, timeout_sec=0.1 + cls.server_node, executor=cls._server_executor, timeout_sec=0.1 ) - self._server_thread = threading.Thread(target=server) - self._server_thread.start() + cls._server_thread = threading.Thread(target=server) + cls._server_thread.start() # wait for discovery - while self.server_node.get_name() not in self.client_node.get_node_names(): + while cls.server_node.get_name() not in cls.client_node.get_node_names(): time.sleep(0.1) - while self.client_node.get_name() not in self.server_node.get_node_names(): + while cls.client_node.get_name() not in cls.server_node.get_node_names(): time.sleep(0.1) - self.rmf_service = RmfService(self.client_node) + cls.rmf_service = RmfService(cls.client_node) - def tearDown(self) -> None: - self._client_context.shutdown() - self._client_executor.shutdown() - self._client_thread.join() - self._server_context.shutdown() - self._server_executor.shutdown() - self._server_thread.join() + @classmethod + def tearDownClass(cls) -> None: + cls._client_context.shutdown() + cls._client_executor.shutdown() + cls._client_thread.join() + cls._server_context.shutdown() + cls._server_executor.shutdown() + cls._server_thread.join() def test_call(self): async def run(): From e91cfb4d7ea6cda8866ab24308ffde36c149afa0 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Tue, 4 Jan 2022 03:18:02 +0000 Subject: [PATCH 03/79] fix lint errors Signed-off-by: Teo Koon Peng --- .../api-server/api_server/repositories/fleets.py | 5 +++-- .../api-server/api_server/repositories/rmf.py | 3 ++- .../api-server/api_server/repositories/tasks.py | 5 +++-- .../api-server/api_server/rmf_io/book_keeper.py | 5 +++-- .../api-server/api_server/rmf_io/rmf_service.py | 3 ++- packages/api-server/api_server/routes/fleets.py | 5 +++-- .../api-server/api_server/routes/tasks/tasks.py | 6 +++--- packages/api-server/api_server/test/test_data.py | 15 ++++++++------- 8 files changed, 27 insertions(+), 20 deletions(-) diff --git a/packages/api-server/api_server/repositories/fleets.py b/packages/api-server/api_server/repositories/fleets.py index 58b93b2ee..2f1674819 100644 --- a/packages/api-server/api_server/repositories/fleets.py +++ b/packages/api-server/api_server/repositories/fleets.py @@ -1,12 +1,13 @@ from typing import List, Optional +from fastapi import Depends +from tortoise.queryset import QuerySet + from api_server.authenticator import user_dep from api_server.models import FleetLog, FleetState, Pagination, User from api_server.models.tortoise_models import FleetLog as DbFleetLog from api_server.models.tortoise_models import FleetState as DbFleetState from api_server.query import add_pagination -from fastapi import Depends -from tortoise.queryset import QuerySet class FleetRepository: diff --git a/packages/api-server/api_server/repositories/rmf.py b/packages/api-server/api_server/repositories/rmf.py index 32ff6646b..693715c87 100644 --- a/packages/api-server/api_server/repositories/rmf.py +++ b/packages/api-server/api_server/repositories/rmf.py @@ -1,5 +1,7 @@ from typing import List, Optional, cast +from fastapi import Depends + from api_server.authenticator import user_dep from api_server.models import ( BuildingMap, @@ -20,7 +22,6 @@ ) from api_server.models import tortoise_models as ttm from api_server.query import add_pagination -from fastapi import Depends class RmfRepository: diff --git a/packages/api-server/api_server/repositories/tasks.py b/packages/api-server/api_server/repositories/tasks.py index e5d808f76..d36c66abd 100644 --- a/packages/api-server/api_server/repositories/tasks.py +++ b/packages/api-server/api_server/repositories/tasks.py @@ -1,12 +1,13 @@ from typing import List, Optional +from fastapi import Depends +from tortoise.queryset import QuerySet + from api_server.authenticator import user_dep from api_server.models import Pagination, TaskEventLog, TaskState, User from api_server.models.tortoise_models import TaskEventLog as DbTaskEventLog from api_server.models.tortoise_models import TaskState as DbTaskState from api_server.query import add_pagination -from fastapi import Depends -from tortoise.queryset import QuerySet class TaskRepository: diff --git a/packages/api-server/api_server/rmf_io/book_keeper.py b/packages/api-server/api_server/rmf_io/book_keeper.py index ba2614d9a..09fec4926 100644 --- a/packages/api-server/api_server/rmf_io/book_keeper.py +++ b/packages/api-server/api_server/rmf_io/book_keeper.py @@ -4,6 +4,9 @@ from collections import namedtuple from typing import Coroutine, List +from rx.core.typing import Disposable +from rx.subject.subject import Subject + from api_server.models import ( BuildingMap, DispenserHealth, @@ -17,8 +20,6 @@ LiftState, ) from api_server.models.health import BaseBasicHealth -from rx.core.typing import Disposable -from rx.subject.subject import Subject from .events import RmfEvents diff --git a/packages/api-server/api_server/rmf_io/rmf_service.py b/packages/api-server/api_server/rmf_io/rmf_service.py index ab5d4754e..396662413 100644 --- a/packages/api-server/api_server/rmf_io/rmf_service.py +++ b/packages/api-server/api_server/rmf_io/rmf_service.py @@ -5,9 +5,10 @@ import rclpy import rclpy.node import rclpy.qos -from api_server.logger import logger from rmf_task_msgs.msg import ApiRequest, ApiResponse +from api_server.logger import logger + class RmfService: """ diff --git a/packages/api-server/api_server/routes/fleets.py b/packages/api-server/api_server/routes/fleets.py index 199a9ebe4..324f6a9b1 100644 --- a/packages/api-server/api_server/routes/fleets.py +++ b/packages/api-server/api_server/routes/fleets.py @@ -1,13 +1,14 @@ from typing import List, Optional, cast +from fastapi import Depends, HTTPException, Query +from rx import operators as rxops + from api_server.dependencies import pagination_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest from api_server.models import FleetLog, FleetState, Pagination from api_server.models.tortoise_models import FleetState as DbFleetState from api_server.repositories import FleetRepository, fleet_repo_dep from api_server.rmf_io import fleet_events -from fastapi import Depends, HTTPException, Query -from rx import operators as rxops router = FastIORouter(tags=["Fleets"]) diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index fc79b0d7c..a38837b72 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -1,10 +1,12 @@ from datetime import datetime from typing import List, Optional, cast +from fastapi import Body, Depends, HTTPException, Path, Query +from rx import operators as rxops + from api_server.authenticator import user_dep from api_server.dependencies import pagination_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest -from api_server.gateway import rmf_gateway from api_server.models import ( CancelTaskRequest, Pagination, @@ -17,8 +19,6 @@ from api_server.models.tortoise_models import TaskState as DbTaskState from api_server.repositories import TaskRepository, task_repo_dep from api_server.rmf_io import task_events -from fastapi import Body, Depends, HTTPException, Path, Query -from rx import operators as rxops router = FastIORouter(tags=["Tasks"]) diff --git a/packages/api-server/api_server/test/test_data.py b/packages/api-server/api_server/test/test_data.py index 84390d800..f31046a6a 100644 --- a/packages/api-server/api_server/test/test_data.py +++ b/packages/api-server/api_server/test/test_data.py @@ -1,5 +1,11 @@ import json +from rmf_building_map_msgs.msg import Door as RmfDoor +from rmf_dispenser_msgs.msg import DispenserState as RmfDispenserState +from rmf_door_msgs.msg import DoorMode as RmfDoorMode +from rmf_ingestor_msgs.msg import IngestorState as RmfIngestorState +from rmf_lift_msgs.msg import LiftState as RmfLiftState + from api_server.models import ( AffineImage, BuildingMap, @@ -16,11 +22,6 @@ TaskEventLog, TaskState, ) -from rmf_building_map_msgs.msg import Door as RmfDoor -from rmf_dispenser_msgs.msg import DispenserState as RmfDispenserState -from rmf_door_msgs.msg import DoorMode as RmfDoorMode -from rmf_ingestor_msgs.msg import IngestorState as RmfIngestorState -from rmf_lift_msgs.msg import LiftState as RmfLiftState def make_door(name: str = "test_door") -> Door: @@ -98,11 +99,11 @@ def make_ingestor_state(guid: str = "test_ingestor") -> IngestorState: def make_fleet_state(name: str = "test_fleet") -> FleetState: - return FleetState(name=name, robots=[]) + return FleetState(name=name, robots={}) def make_fleet_log(name: str = "test_fleet") -> FleetLog: - return FleetLog(name=name) + return FleetLog(name=name, log=[], robots={}) def make_task_state(task_id: str = "test_task") -> TaskState: From d8250d8ee477fd85994827297ffe828e497e2894 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 5 Jan 2022 03:49:13 +0000 Subject: [PATCH 04/79] proper db model for task logs; add querying by time Signed-off-by: Teo Koon Peng --- .../api-server/api_server/models/__init__.py | 1 + packages/api-server/api_server/models/log.py | 13 ++++ .../api-server/api_server/models/tasks.py | 65 +++++++++++++++---- .../models/tortoise_models/__init__.py | 10 ++- .../api_server/models/tortoise_models/log.py | 17 +++++ .../models/tortoise_models/tasks.py | 43 +++++++++++- .../api_server/repositories/tasks.py | 51 +++++++++++++-- .../api_server/routes/tasks/tasks.py | 21 +++++- .../api_server/routes/tasks/test_tasks.py | 64 +++++++++++++++++- .../api-server/api_server/test/test_data.py | 4 +- .../api_server/test/test_fixtures.py | 21 +++++- packages/api-server/api_server/time.py | 8 +++ 12 files changed, 292 insertions(+), 26 deletions(-) create mode 100644 packages/api-server/api_server/models/log.py create mode 100644 packages/api-server/api_server/models/tortoise_models/log.py create mode 100644 packages/api-server/api_server/time.py diff --git a/packages/api-server/api_server/models/__init__.py b/packages/api-server/api_server/models/__init__.py index 52583366e..295bd96a9 100644 --- a/packages/api-server/api_server/models/__init__.py +++ b/packages/api-server/api_server/models/__init__.py @@ -6,6 +6,7 @@ from .health import * from .ingestors import * from .lifts import * +from .log import LogEntry from .pagination import * from .rmf_api.cancel_task_request import CancelTaskRequest from .rmf_api.cancel_task_response import TaskCancelResponse diff --git a/packages/api-server/api_server/models/log.py b/packages/api-server/api_server/models/log.py new file mode 100644 index 000000000..e7211e497 --- /dev/null +++ b/packages/api-server/api_server/models/log.py @@ -0,0 +1,13 @@ +from .rmf_api.log_entry import LogEntry as BaseLogEntry +from .tortoise_models import LogMixin + + +class LogEntry(BaseLogEntry): + @staticmethod + def from_tortoise(tortoise_log: LogMixin): + return LogEntry.construct( + seq=tortoise_log.seq, + unix_millis_time=tortoise_log.unix_millis_time, + tier=tortoise_log.tier.name, + text=tortoise_log.text, + ) diff --git a/packages/api-server/api_server/models/tasks.py b/packages/api-server/api_server/models/tasks.py index 2889cc211..5e5744fe0 100644 --- a/packages/api-server/api_server/models/tasks.py +++ b/packages/api-server/api_server/models/tasks.py @@ -1,18 +1,21 @@ from datetime import datetime +from typing import Any, Dict, Sequence +from tortoise.transactions import in_transaction + +from . import tortoise_models as ttm +from .rmf_api.log_entry import LogEntry from .rmf_api.task_log import TaskEventLog as BaseTaskEventLog from .rmf_api.task_state import TaskState as BaseTaskState -from .tortoise_models import TaskEventLog as DbTaskEventLog -from .tortoise_models import TaskState as DbTaskState class TaskState(BaseTaskState): @staticmethod - def from_db(task_state: DbTaskState) -> "TaskState": + def from_db(task_state: ttm.TaskState) -> "TaskState": return TaskState(**task_state.data) async def save(self) -> None: - await DbTaskState.update_or_create( + await ttm.TaskState.update_or_create( { "data": self.json(), "category": self.category, @@ -26,12 +29,52 @@ async def save(self) -> None: class TaskEventLog(BaseTaskEventLog): - @staticmethod - def from_db(task_log: DbTaskEventLog) -> "TaskEventLog": - return TaskEventLog(**task_log.data) + async def _saveEventLogs( + self, + db_phase: ttm.TaskEventLogPhases, + events: Dict[str, Sequence[Dict[str, Any]]], + ): + for event_id, logs in events.items(): + for log in logs: + await ttm.TaskEventLogPhasesEvents.get_or_create( + phase=db_phase, event=event_id, **log + ) + + async def _savePhaseLogs( + self, db_task_log: ttm.TaskEventLog, phases: Dict[str, Dict[str, Dict]] + ): + for phase_id, phase in phases.items(): + db_phase = ( + await ttm.TaskEventLogPhases.get_or_create( + task=db_task_log, phase=phase_id + ) + )[0] + for log in phase["log"]: + await ttm.TaskEventLogPhasesLog.create( + phase=db_phase, + **log, + ) + if "events" in phase: + await self._saveEventLogs(db_phase, phase["events"]) + + async def _saveTaskLogs( + self, db_task_log: ttm.TaskEventLog, logs: Sequence[LogEntry] + ): + for log in logs: + await ttm.TaskEventLogLog.create( + task=db_task_log, + seq=log.seq, + unix_millis_time=log.unix_millis_time, + tier=log.tier.name, + text=log.text, + ) async def save(self) -> None: - await DbTaskEventLog.update_or_create( - {"data": self.json()}, - task_id=self.task_id, - ) + async with in_transaction(): + db_task_log = (await ttm.TaskEventLog.get_or_create(task_id=self.task_id))[ + 0 + ] + if self.log: + await self._saveTaskLogs(db_task_log, self.log) + if self.phases: + await self._savePhaseLogs(db_task_log, self.phases) diff --git a/packages/api-server/api_server/models/tortoise_models/__init__.py b/packages/api-server/api_server/models/tortoise_models/__init__.py index 7c1dda793..3dbd01622 100644 --- a/packages/api-server/api_server/models/tortoise_models/__init__.py +++ b/packages/api-server/api_server/models/tortoise_models/__init__.py @@ -13,5 +13,13 @@ ) from .ingestor_state import IngestorState from .lift_state import LiftState -from .tasks import TaskEventLog, TaskState +from .log import LogEntryTier, LogMixin +from .tasks import ( + TaskEventLog, + TaskEventLogLog, + TaskEventLogPhases, + TaskEventLogPhasesEvents, + TaskEventLogPhasesLog, + TaskState, +) from .user import * diff --git a/packages/api-server/api_server/models/tortoise_models/log.py b/packages/api-server/api_server/models/tortoise_models/log.py new file mode 100644 index 000000000..eb771f40e --- /dev/null +++ b/packages/api-server/api_server/models/tortoise_models/log.py @@ -0,0 +1,17 @@ +from enum import Enum + +from tortoise.fields import CharEnumField, IntField, TextField + + +class LogEntryTier(Enum): + uninitialized = "uninitialized" + info = "info" + warning = "warning" + error = "error" + + +class LogMixin: + seq = IntField() + unix_millis_time = IntField(null=False, index=True) + tier = CharEnumField(LogEntryTier, max_length=255) + text = TextField() diff --git a/packages/api-server/api_server/models/tortoise_models/tasks.py b/packages/api-server/api_server/models/tortoise_models/tasks.py index 47ea712a0..d018d4257 100644 --- a/packages/api-server/api_server/models/tortoise_models/tasks.py +++ b/packages/api-server/api_server/models/tortoise_models/tasks.py @@ -1,6 +1,15 @@ -from tortoise.fields import CharField, DatetimeField, JSONField +from tortoise.fields import ( + CharField, + DatetimeField, + ForeignKeyField, + ForeignKeyRelation, + JSONField, + ReverseRelation, +) from tortoise.models import Model +from .log import LogMixin + class TaskState(Model): id_ = CharField(255, pk=True, source_field="id") @@ -12,4 +21,34 @@ class TaskState(Model): class TaskEventLog(Model): task_id = CharField(255, pk=True) - data = JSONField() + log: ReverseRelation["TaskEventLogLog"] + phases: ReverseRelation["TaskEventLogPhases"] + + +class TaskEventLogLog(Model, LogMixin): + task: ForeignKeyRelation[TaskEventLog] = ForeignKeyField("models.TaskEventLog", related_name="log") # type: ignore + + class Meta: + unique_together = ("task", "seq") + + +class TaskEventLogPhases(Model): + task: ForeignKeyRelation[TaskEventLog] = ForeignKeyField("models.TaskEventLog", related_name="phases") # type: ignore + phase = CharField(255) + log: ReverseRelation["TaskEventLogPhasesLog"] + events: ReverseRelation["TaskEventLogPhasesEvents"] + + +class TaskEventLogPhasesLog(Model, LogMixin): + phase: ForeignKeyRelation[TaskEventLogPhases] = ForeignKeyField("models.TaskEventLogPhases", related_name="log") # type: ignore + + class Meta: + unique_together = ("phase", "seq") + + +class TaskEventLogPhasesEvents(Model, LogMixin): + phase: ForeignKeyRelation[TaskEventLogPhases] = ForeignKeyField("models.TaskEventLogPhases", related_name="events") # type: ignore + event = CharField(255) + + class Meta: + unique_together = ("phase", "event", "seq") diff --git a/packages/api-server/api_server/repositories/tasks.py b/packages/api-server/api_server/repositories/tasks.py index d36c66abd..75f9d0cc4 100644 --- a/packages/api-server/api_server/repositories/tasks.py +++ b/packages/api-server/api_server/repositories/tasks.py @@ -1,11 +1,12 @@ -from typing import List, Optional +from typing import List, Optional, Tuple, cast from fastapi import Depends +from tortoise.query_utils import Prefetch from tortoise.queryset import QuerySet from api_server.authenticator import user_dep -from api_server.models import Pagination, TaskEventLog, TaskState, User -from api_server.models.tortoise_models import TaskEventLog as DbTaskEventLog +from api_server.models import LogEntry, Pagination, TaskEventLog, TaskState, User +from api_server.models import tortoise_models as ttm from api_server.models.tortoise_models import TaskState as DbTaskState from api_server.query import add_pagination @@ -30,11 +31,49 @@ async def get_task_state(self, task_id: str) -> Optional[TaskState]: return None return TaskState(**result.data) - async def get_task_log(self, task_id: str) -> Optional[TaskEventLog]: - result = await DbTaskEventLog.get_or_none(task_id=task_id) + async def get_task_log( + self, task_id: str, between: Tuple[int, int] + ) -> Optional[TaskEventLog]: + """ + :param between: The period in unix millis to fetch. + """ + between_filters = { + "unix_millis_time__gte": between[0], + "unix_millis_time__lte": between[1], + } + result = cast( + Optional[ttm.TaskEventLog], + await ttm.TaskEventLog.get_or_none(task_id=task_id).prefetch_related( + Prefetch( + "log", + ttm.TaskEventLogLog.filter(**between_filters), + ), + Prefetch( + "phases__log", ttm.TaskEventLogPhasesLog.filter(**between_filters) + ), + Prefetch( + "phases__events", + ttm.TaskEventLogPhasesEvents.filter(**between_filters), + ), + ), + ) if result is None: return None - return TaskEventLog(**result.data) + phases = {} + for db_phase in result.phases: + phase = {} + phase["log"] = [LogEntry.from_tortoise(x) for x in db_phase.log] + events = {} + for db_event in db_phase.events: + event: List = events.setdefault(db_event.event, []) + event.append(LogEntry.from_tortoise(db_event)) + phase["events"] = events + phases[db_phase.phase] = phase + return TaskEventLog.construct( + task_id=result.task_id, + log=[LogEntry.from_tortoise(x) for x in list(result.log)], + phases=phases, + ) def task_repo_dep(user: User = Depends(user_dep)): diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index a38837b72..b8aa2e2f2 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -19,6 +19,7 @@ from api_server.models.tortoise_models import TaskState as DbTaskState from api_server.repositories import TaskRepository, task_repo_dep from api_server.rmf_io import task_events +from api_server.time import now router = FastIORouter(tags=["Tasks"]) @@ -78,11 +79,29 @@ async def sub_task_state(req: SubscriptionRequest, task_id: str): async def get_task_log( task_repo: TaskRepository = Depends(task_repo_dep), task_id: str = Path(..., description="task_id"), + between: str = Query( + "-60000", + description=""" + The period of time to fetch, in unix millis. + + This can be either a comma separated string or a string prefixed with '-' to fetch the last X millis. + + Example: + "1000,2000" - Fetches logs between unix millis 1000 and 2000. + "-60000" - Fetches logs in the last minute. + """, + ), + now: int = Depends(now), ): """ Available in socket.io """ - result = await task_repo.get_task_log(task_id) + if between.startswith("-"): + period = (now - int(between[1:]), now) + else: + parts = between.split(",") + period = (int(parts[0]), int(parts[1])) + result = await task_repo.get_task_log(task_id, period) if result is None: raise HTTPException(status_code=404) return result diff --git a/packages/api-server/api_server/routes/tasks/test_tasks.py b/packages/api-server/api_server/routes/tasks/test_tasks.py index f6f3d3225..318f00902 100644 --- a/packages/api-server/api_server/routes/tasks/test_tasks.py +++ b/packages/api-server/api_server/routes/tasks/test_tasks.py @@ -1,5 +1,6 @@ from uuid import uuid4 +from api_server.models import TaskEventLog from api_server.test import AppFixture, make_task_log, make_task_state, try_until @@ -38,9 +39,68 @@ def test_sub_task_state(self): self.assertEqual(self.task_states[0].booking.id, result["booking"]["id"]) def test_get_task_log(self): - resp = self.session.get(f"/tasks/{self.task_logs[0].task_id}/log") + resp = self.session.get( + f"/tasks/{self.task_logs[0].task_id}/log?between=0,1636388414500" + ) self.assertEqual(200, resp.status_code) - self.assertEqual(self.task_logs[0].task_id, resp.json()["task_id"]) + logs = TaskEventLog(**resp.json()) + self.assertEqual(self.task_logs[0].task_id, logs.task_id) + + # check task log + if logs.log is None: + self.assertIsNotNone(logs.log) + return + self.assertEqual(1, len(logs.log)) + log = logs.log[0] + self.assertEqual(0, log.seq) + self.assertEqual("info", log.tier.name) + self.assertEqual(1636388410000, log.unix_millis_time) + self.assertEqual("Beginning task", log.text) + + # check number of phases + if logs.phases is None: + self.assertIsNotNone(logs.phases) + return + self.assertEqual(2, len(logs.phases)) + self.assertIn("1", logs.phases) + self.assertIn("2", logs.phases) + + # check correct log + phase1 = logs.phases["1"] + self.assertIn("log", phase1) + phase1_log = phase1["log"] + self.assertEqual(1, len(phase1_log)) + log = phase1_log[0] + self.assertEqual(0, log["seq"]) + self.assertEqual("info", log["tier"]) + self.assertEqual(1636388410000, log["unix_millis_time"]) + self.assertEqual("Beginning phase", log["text"]) + + # check number of events + self.assertIn("events", phase1) + phase1_events = phase1["events"] + self.assertEqual( + 3, len(phase1_events) + ) # check only events with logs in the period are returned + + # check event log + self.assertIn("1", phase1_events) + self.assertEqual( + 3, len(phase1_events["1"]) + ) # check only logs in the period is returned + log = phase1_events["1"][0] + self.assertEqual(0, log["seq"]) + self.assertEqual("info", log["tier"]) + self.assertEqual(1636388409995, log["unix_millis_time"]) + self.assertEqual( + "Generating plan to get from [place:parking_03] to [place:kitchen]", + log["text"], + ) + + # TODO: check relative time is working, this requires the use of + # dependencies overrides, which requires change in the server architecture. + # Better to do this after this gets merged into main so we don't make + # more architecture changes. def test_sub_task_log(self): fut = self.subscribe_sio(f"/tasks/{self.task_logs[0].task_id}/log") diff --git a/packages/api-server/api_server/test/test_data.py b/packages/api-server/api_server/test/test_data.py index f31046a6a..85061f102 100644 --- a/packages/api-server/api_server/test/test_data.py +++ b/packages/api-server/api_server/test/test_data.py @@ -409,7 +409,7 @@ def make_task_state(task_id: str = "test_task") -> TaskState: def make_task_log(task_id: str) -> TaskEventLog: - sample = TaskEventLog.construct( + sample = TaskEventLog( **json.loads( """ { @@ -617,7 +617,7 @@ def make_task_log(task_id: str) -> TaskEventLog: "text": "Finished generating plan to get from [place:kitchen_03] to [place:room_203]" }, { - "seq": 0, + "seq": 2, "tier": "info", "unix_millis_time": 1636388450000, "text": "Finished: Move to [place:kitchen_door_interior]" diff --git a/packages/api-server/api_server/test/test_fixtures.py b/packages/api-server/api_server/test/test_fixtures.py index f2eaed4fa..613f0cc79 100644 --- a/packages/api-server/api_server/test/test_fixtures.py +++ b/packages/api-server/api_server/test/test_fixtures.py @@ -5,7 +5,17 @@ import time import unittest from concurrent.futures import Future -from typing import Any, Awaitable, Callable, List, Optional, TypeVar, Union, cast +from typing import ( + Any, + Awaitable, + Callable, + List, + Optional, + Sequence, + TypeVar, + Union, + cast, +) from uuid import uuid4 import jwt @@ -102,6 +112,9 @@ def request(self, method, url, **kwargs): # pylint: disable=arguments-differ class AppFixture(unittest.TestCase): + def __init__(self): + self.test_time = 0 + @classmethod def setUpClass(cls): cls.server = test_server @@ -200,3 +213,9 @@ def add_permission(self, role: str, action: str, authz_grp: Optional[str] = ""): def assign_role(self, username: str, role: str): resp = self.session.post(f"/admin/users/{username}/roles", json={"name": role}) self.assertEqual(200, resp.status_code) + + def now(self) -> int: + """ + Returns the current time in the testing clock in unix millis. + """ + return self.test_time diff --git a/packages/api-server/api_server/time.py b/packages/api-server/api_server/time.py new file mode 100644 index 000000000..398b63c28 --- /dev/null +++ b/packages/api-server/api_server/time.py @@ -0,0 +1,8 @@ +import time + + +def now() -> int: + """ + Return current unix time in millis + """ + return int(time.time() * 1000) From db4b609f154e0c6bb4aec422b50321336f6b8bfd Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 5 Jan 2022 04:25:55 +0000 Subject: [PATCH 05/79] update task sub route; fix tests Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/routes/tasks/tasks.py | 6 +----- .../api-server/api_server/routes/tasks/test_tasks.py | 11 +++++++---- packages/api-server/api_server/test/test_fixtures.py | 7 ++++--- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index b8aa2e2f2..5b61a41b4 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -108,11 +108,7 @@ async def get_task_log( @router.sub("/{task_id}/log", response_model=TaskEventLog) -async def sub_task_log(req: SubscriptionRequest, task_id: str): - user = sio_user(req) - task_repo = TaskRepository(user) - current = await get_task_log(task_repo, task_id) - await req.sio.emit(req.room, current, req.sid) +async def sub_task_log(_req: SubscriptionRequest, task_id: str): return task_events.task_event_logs.pipe( rxops.filter(lambda x: cast(TaskEventLog, x).task_id == task_id) ) diff --git a/packages/api-server/api_server/routes/tasks/test_tasks.py b/packages/api-server/api_server/routes/tasks/test_tasks.py index 318f00902..ea22301b3 100644 --- a/packages/api-server/api_server/routes/tasks/test_tasks.py +++ b/packages/api-server/api_server/routes/tasks/test_tasks.py @@ -1,6 +1,7 @@ from uuid import uuid4 from api_server.models import TaskEventLog +from api_server.rmf_io import task_events from api_server.test import AppFixture, make_task_log, make_task_state, try_until @@ -103,7 +104,9 @@ def test_get_task_log(self): # more architecture changes. def test_sub_task_log(self): - fut = self.subscribe_sio(f"/tasks/{self.task_logs[0].task_id}/log") - try_until(fut.done, lambda x: x) - result = fut.result(0) - self.assertEqual(self.task_logs[0].task_id, result["task_id"]) + task_id = f"task_{uuid4()}" + fut = self.subscribe_sio(f"/tasks/{task_id}/log") + task_logs = make_task_log(task_id) + task_events.task_event_logs.on_next(task_logs) + result = fut.result(1) + self.assertEqual(task_id, result["task_id"]) diff --git a/packages/api-server/api_server/test/test_fixtures.py b/packages/api-server/api_server/test/test_fixtures.py index 613f0cc79..5720b43d3 100644 --- a/packages/api-server/api_server/test/test_fixtures.py +++ b/packages/api-server/api_server/test/test_fixtures.py @@ -112,9 +112,6 @@ def request(self, method, url, **kwargs): # pylint: disable=arguments-differ class AppFixture(unittest.TestCase): - def __init__(self): - self.test_time = 0 - @classmethod def setUpClass(cls): cls.server = test_server @@ -133,6 +130,7 @@ def tearDownClass(cls): cls.session.close() def setUp(self): + self.test_time = 0 self._sioClients: List[socketio.Client] = [] def tearDown(self): @@ -178,7 +176,10 @@ def on_event(data): fut.set_result(data) client.on(room, on_event) + subscribe_fut = Future() + client.on("subscribe", subscribe_fut.set_result) client.emit("subscribe", {"room": room}) + subscribe_fut.result(1) return fut From cb608a8599aa84fac82fb1be994be1ae87823f68 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 5 Jan 2022 04:50:33 +0000 Subject: [PATCH 06/79] update internal ws app Signed-off-by: Teo Koon Peng --- .../api-server/api_server/models/tasks.py | 14 +++++-- .../api-server/api_server/rmf_gateway_app.py | 28 +------------ .../api_server/test_rmf_gateway_app.py | 42 ++++++++++++++----- 3 files changed, 44 insertions(+), 40 deletions(-) diff --git a/packages/api-server/api_server/models/tasks.py b/packages/api-server/api_server/models/tasks.py index 5e5744fe0..6a1ece4e5 100644 --- a/packages/api-server/api_server/models/tasks.py +++ b/packages/api-server/api_server/models/tasks.py @@ -1,8 +1,11 @@ from datetime import datetime from typing import Any, Dict, Sequence +from tortoise.exceptions import IntegrityError from tortoise.transactions import in_transaction +from api_server.logger import logger + from . import tortoise_models as ttm from .rmf_api.log_entry import LogEntry from .rmf_api.task_log import TaskEventLog as BaseTaskEventLog @@ -74,7 +77,10 @@ async def save(self) -> None: db_task_log = (await ttm.TaskEventLog.get_or_create(task_id=self.task_id))[ 0 ] - if self.log: - await self._saveTaskLogs(db_task_log, self.log) - if self.phases: - await self._savePhaseLogs(db_task_log, self.phases) + try: + if self.log: + await self._saveTaskLogs(db_task_log, self.log) + if self.phases: + await self._savePhaseLogs(db_task_log, self.phases) + except IntegrityError as e: + logger.error(f"{type(e).__name__}:{e}") diff --git a/packages/api-server/api_server/rmf_gateway_app.py b/packages/api-server/api_server/rmf_gateway_app.py index 0ff545e53..ab08cb03d 100644 --- a/packages/api-server/api_server/rmf_gateway_app.py +++ b/packages/api-server/api_server/rmf_gateway_app.py @@ -23,32 +23,8 @@ async def process_msg(msg: Dict[str, Any]) -> None: await task_state.save() task_events.task_states.on_next(task_state) elif payload_type == "task_log_update": - task_log = mdl.TaskEventLog.construct(**msg["data"]) - current_log = mdl.TaskEventLog.from_db( - ( - await dbmdl.TaskEventLog.get_or_create( - {"data": task_log.json()}, task_id=task_log.task_id - ) - )[0] - ) - if task_log.log: - if current_log.log is None: - current_log.log = [] - current_log.log.extend(task_log.log) - if task_log.phases: - if current_log.phases is None: - current_log.phases = {} - for phase_name, phase in task_log.phases.items(): - current_phase = current_log.phases.setdefault(phase_name, {}) - if "log" in phase: - current_phase_logs = current_phase.setdefault("log", []) - current_phase_logs.extend(phase["log"]) - if "events" in phase: - current_events = current_phase.setdefault("events", {}) - for event_name, event in phase["events"].items(): - current_event = current_events.setdefault(event_name, []) - current_event.extend(event) - await current_log.save() + task_log = mdl.TaskEventLog(**msg["data"]) + await task_log.save() task_events.task_event_logs.on_next(task_log) elif payload_type == "fleet_state_update": fleet_state = mdl.FleetState.construct(**msg["data"]) diff --git a/packages/api-server/api_server/test_rmf_gateway_app.py b/packages/api-server/api_server/test_rmf_gateway_app.py index 7402c35bd..16abef8e0 100644 --- a/packages/api-server/api_server/test_rmf_gateway_app.py +++ b/packages/api-server/api_server/test_rmf_gateway_app.py @@ -1,12 +1,16 @@ # NOTE: This will eventually replace `gateway.py`` +from concurrent.futures import Future from uuid import uuid4 +import rx.operators as rxops import websocket from fastapi import FastAPI from .app_config import app_config +from .models import TaskEventLog from .models.rmf_api.task_log_update import TaskEventLogUpdate -from .test import AppFixture, make_task_log, try_until +from .rmf_io import task_events +from .test import AppFixture, make_task_log app = FastAPI() @@ -24,14 +28,32 @@ def tearDownClass(cls): super().tearDownClass() def test_task_log_update(self): - task_log = make_task_log(uuid4().hex) - task_log_update = TaskEventLogUpdate.construct( - type="task_log_update", data=task_log - ) + task_id = f"task_{uuid4()}" + task_log = make_task_log(task_id) + task_log_update = TaskEventLogUpdate(type="task_log_update", data=task_log) + fut = Future() + task_events.task_event_logs.subscribe(fut.set_result) self.ws.send(task_log_update.json()) - resp = try_until( - lambda: self.session.get(f"/tasks/{task_log.task_id}/log"), - lambda x: x.status_code == 200, - ) + + result: TaskEventLog = fut.result(1) + self.assertEqual(task_id, result.task_id) + resp = self.session.get(f"/tasks/{task_id}/log?between=0,1636388414500") self.assertEqual(200, resp.status_code) - self.assertEqual(task_log.task_id, resp.json()["task_id"]) + self.assertEqual(task_id, resp.json()["task_id"]) + + def test_task_log_update_can_receive_duplicate_logs(self): + """ + Logs come in as partial updates, so it is hard to find any duplicates in them. + The expected behavior is for saving duplicated logs to fail silently, but still + publishes all received updates, including duplicated ones. + """ + task_id = f"task_{uuid4()}" + task_log = make_task_log(task_id) + task_log_update = TaskEventLogUpdate(type="task_log_update", data=task_log) + + # send same log twice + for _ in range(2): + fut = Future() + task_events.task_event_logs.pipe(rxops.take(1)).subscribe(fut.set_result) + self.ws.send(task_log_update.json()) + fut.result(1) From 3f4c9e2058ccef261f3eeaee5af5261452c24b89 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 5 Jan 2022 05:28:28 +0000 Subject: [PATCH 07/79] improve db model Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/models/tasks.py | 7 +++++-- .../api_server/models/tortoise_models/__init__.py | 1 + .../api_server/models/tortoise_models/tasks.py | 11 ++++++++--- packages/api-server/api_server/repositories/tasks.py | 11 ++++++----- .../api-server/api_server/routes/tasks/test_tasks.py | 4 ++-- .../api-server/api_server/test_rmf_gateway_app.py | 3 +-- 6 files changed, 23 insertions(+), 14 deletions(-) diff --git a/packages/api-server/api_server/models/tasks.py b/packages/api-server/api_server/models/tasks.py index 6a1ece4e5..8db4b52a6 100644 --- a/packages/api-server/api_server/models/tasks.py +++ b/packages/api-server/api_server/models/tasks.py @@ -38,10 +38,13 @@ async def _saveEventLogs( events: Dict[str, Sequence[Dict[str, Any]]], ): for event_id, logs in events.items(): - for log in logs: + db_event = ( await ttm.TaskEventLogPhasesEvents.get_or_create( - phase=db_phase, event=event_id, **log + phase=db_phase, event=event_id ) + )[0] + for log in logs: + await ttm.TaskEventLogPhasesEventsLog.create(event=db_event, **log) async def _savePhaseLogs( self, db_task_log: ttm.TaskEventLog, phases: Dict[str, Dict[str, Dict]] diff --git a/packages/api-server/api_server/models/tortoise_models/__init__.py b/packages/api-server/api_server/models/tortoise_models/__init__.py index 3dbd01622..3082c0976 100644 --- a/packages/api-server/api_server/models/tortoise_models/__init__.py +++ b/packages/api-server/api_server/models/tortoise_models/__init__.py @@ -19,6 +19,7 @@ TaskEventLogLog, TaskEventLogPhases, TaskEventLogPhasesEvents, + TaskEventLogPhasesEventsLog, TaskEventLogPhasesLog, TaskState, ) diff --git a/packages/api-server/api_server/models/tortoise_models/tasks.py b/packages/api-server/api_server/models/tortoise_models/tasks.py index d018d4257..f383f7dd3 100644 --- a/packages/api-server/api_server/models/tortoise_models/tasks.py +++ b/packages/api-server/api_server/models/tortoise_models/tasks.py @@ -43,12 +43,17 @@ class TaskEventLogPhasesLog(Model, LogMixin): phase: ForeignKeyRelation[TaskEventLogPhases] = ForeignKeyField("models.TaskEventLogPhases", related_name="log") # type: ignore class Meta: - unique_together = ("phase", "seq") + unique_together = ("id", "seq") -class TaskEventLogPhasesEvents(Model, LogMixin): +class TaskEventLogPhasesEvents(Model): phase: ForeignKeyRelation[TaskEventLogPhases] = ForeignKeyField("models.TaskEventLogPhases", related_name="events") # type: ignore event = CharField(255) + log: ReverseRelation["TaskEventLogPhasesEventsLog"] + + +class TaskEventLogPhasesEventsLog(Model, LogMixin): + event: ForeignKeyRelation[TaskEventLogPhasesEvents] = ForeignKeyField("models.TaskEventLogPhasesEvents", related_name="log") # type: ignore class Meta: - unique_together = ("phase", "event", "seq") + unique_together = ("id", "seq") diff --git a/packages/api-server/api_server/repositories/tasks.py b/packages/api-server/api_server/repositories/tasks.py index 75f9d0cc4..eb2a564cb 100644 --- a/packages/api-server/api_server/repositories/tasks.py +++ b/packages/api-server/api_server/repositories/tasks.py @@ -52,8 +52,8 @@ async def get_task_log( "phases__log", ttm.TaskEventLogPhasesLog.filter(**between_filters) ), Prefetch( - "phases__events", - ttm.TaskEventLogPhasesEvents.filter(**between_filters), + "phases__events__log", + ttm.TaskEventLogPhasesEventsLog.filter(**between_filters), ), ), ) @@ -65,13 +65,14 @@ async def get_task_log( phase["log"] = [LogEntry.from_tortoise(x) for x in db_phase.log] events = {} for db_event in db_phase.events: - event: List = events.setdefault(db_event.event, []) - event.append(LogEntry.from_tortoise(db_event)) + events[db_event.event] = [ + LogEntry.from_tortoise(x) for x in db_event.log + ] phase["events"] = events phases[db_phase.phase] = phase return TaskEventLog.construct( task_id=result.task_id, - log=[LogEntry.from_tortoise(x) for x in list(result.log)], + log=[LogEntry.from_tortoise(x) for x in result.log], phases=phases, ) diff --git a/packages/api-server/api_server/routes/tasks/test_tasks.py b/packages/api-server/api_server/routes/tasks/test_tasks.py index ea22301b3..adc869ca7 100644 --- a/packages/api-server/api_server/routes/tasks/test_tasks.py +++ b/packages/api-server/api_server/routes/tasks/test_tasks.py @@ -81,8 +81,8 @@ def test_get_task_log(self): self.assertIn("events", phase1) phase1_events = phase1["events"] self.assertEqual( - 3, len(phase1_events) - ) # check only events with logs in the period are returned + 7, len(phase1_events) + ) # check all events are returned, including those with no logs # check event log self.assertIn("1", phase1_events) diff --git a/packages/api-server/api_server/test_rmf_gateway_app.py b/packages/api-server/api_server/test_rmf_gateway_app.py index 16abef8e0..d93ef0191 100644 --- a/packages/api-server/api_server/test_rmf_gateway_app.py +++ b/packages/api-server/api_server/test_rmf_gateway_app.py @@ -1,4 +1,3 @@ -# NOTE: This will eventually replace `gateway.py`` from concurrent.futures import Future from uuid import uuid4 @@ -32,7 +31,7 @@ def test_task_log_update(self): task_log = make_task_log(task_id) task_log_update = TaskEventLogUpdate(type="task_log_update", data=task_log) fut = Future() - task_events.task_event_logs.subscribe(fut.set_result) + task_events.task_event_logs.pipe(rxops.take(1)).subscribe(fut.set_result) self.ws.send(task_log_update.json()) result: TaskEventLog = fut.result(1) From 75566549f82a52f95f909c0c404053de8f61d106 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 5 Jan 2022 05:57:14 +0000 Subject: [PATCH 08/79] fix race condition with subscribing current state and subscribe success response Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/routes/tasks/tasks.py | 10 ++++++---- .../api-server/api_server/routes/tasks/test_tasks.py | 3 +-- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index 5b61a41b4..33f9d860c 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -3,6 +3,7 @@ from fastapi import Body, Depends, HTTPException, Path, Query from rx import operators as rxops +from rx.subject.replaysubject import ReplaySubject from api_server.authenticator import user_dep from api_server.dependencies import pagination_query, sio_user @@ -69,10 +70,11 @@ async def sub_task_state(req: SubscriptionRequest, task_id: str): user = sio_user(req) task_repo = TaskRepository(user) current_state = await get_task_state(task_repo, task_id) - await req.sio.emit(req.room, current_state, req.sid) - return task_events.task_states.pipe( - rxops.filter(lambda x: cast(TaskState, x).booking.id == task_id) - ) + sub = ReplaySubject(1) + if current_state: + sub.on_next(current_state) + task_events.task_states.subscribe(sub) + return sub @router.get("/{task_id}/log", response_model=TaskEventLog) diff --git a/packages/api-server/api_server/routes/tasks/test_tasks.py b/packages/api-server/api_server/routes/tasks/test_tasks.py index adc869ca7..19e7c4c9c 100644 --- a/packages/api-server/api_server/routes/tasks/test_tasks.py +++ b/packages/api-server/api_server/routes/tasks/test_tasks.py @@ -35,8 +35,7 @@ def test_query_task_states(self): def test_sub_task_state(self): fut = self.subscribe_sio(f"/tasks/{self.task_states[0].booking.id}/state") - try_until(fut.done, lambda x: x) - result = fut.result(0) + result = fut.result(1) self.assertEqual(self.task_states[0].booking.id, result["booking"]["id"]) def test_get_task_log(self): From e0f512c32c693b45b719ca6cd95776226ea62231 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 5 Jan 2022 06:00:06 +0000 Subject: [PATCH 09/79] fix lint errors Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/{time.py => clock.py} | 0 packages/api-server/api_server/routes/tasks/tasks.py | 4 ++-- .../api-server/api_server/routes/tasks/test_tasks.py | 2 +- packages/api-server/api_server/test/test_fixtures.py | 12 +----------- 4 files changed, 4 insertions(+), 14 deletions(-) rename packages/api-server/api_server/{time.py => clock.py} (100%) diff --git a/packages/api-server/api_server/time.py b/packages/api-server/api_server/clock.py similarity index 100% rename from packages/api-server/api_server/time.py rename to packages/api-server/api_server/clock.py diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index 33f9d860c..c7ff60963 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -5,6 +5,7 @@ from rx import operators as rxops from rx.subject.replaysubject import ReplaySubject +from api_server import clock from api_server.authenticator import user_dep from api_server.dependencies import pagination_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest @@ -20,7 +21,6 @@ from api_server.models.tortoise_models import TaskState as DbTaskState from api_server.repositories import TaskRepository, task_repo_dep from api_server.rmf_io import task_events -from api_server.time import now router = FastIORouter(tags=["Tasks"]) @@ -93,7 +93,7 @@ async def get_task_log( "-60000" - Fetches logs in the last minute. """, ), - now: int = Depends(now), + now: int = Depends(clock.now), ): """ Available in socket.io diff --git a/packages/api-server/api_server/routes/tasks/test_tasks.py b/packages/api-server/api_server/routes/tasks/test_tasks.py index 19e7c4c9c..542e64a32 100644 --- a/packages/api-server/api_server/routes/tasks/test_tasks.py +++ b/packages/api-server/api_server/routes/tasks/test_tasks.py @@ -2,7 +2,7 @@ from api_server.models import TaskEventLog from api_server.rmf_io import task_events -from api_server.test import AppFixture, make_task_log, make_task_state, try_until +from api_server.test import AppFixture, make_task_log, make_task_state class TestTasksRoute(AppFixture): diff --git a/packages/api-server/api_server/test/test_fixtures.py b/packages/api-server/api_server/test/test_fixtures.py index 5720b43d3..ac51ba6d0 100644 --- a/packages/api-server/api_server/test/test_fixtures.py +++ b/packages/api-server/api_server/test/test_fixtures.py @@ -5,17 +5,7 @@ import time import unittest from concurrent.futures import Future -from typing import ( - Any, - Awaitable, - Callable, - List, - Optional, - Sequence, - TypeVar, - Union, - cast, -) +from typing import Any, Awaitable, Callable, List, Optional, TypeVar, Union, cast from uuid import uuid4 import jwt From 7b20b8e2348be22f3c5be7ab76934214f2a77dd2 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 5 Jan 2022 06:07:24 +0000 Subject: [PATCH 10/79] fix race condition in other routes Signed-off-by: Teo Koon Peng --- .../api_server/routes/dispensers.py | 10 ++++++---- .../api-server/api_server/routes/doors.py | 10 ++++++---- .../api-server/api_server/routes/fleets.py | 19 +++++++++++-------- .../api-server/api_server/routes/ingestors.py | 10 ++++++---- .../api-server/api_server/routes/lifts.py | 10 ++++++---- .../api_server/routes/test_dispensers.py | 3 +-- 6 files changed, 36 insertions(+), 26 deletions(-) diff --git a/packages/api-server/api_server/routes/dispensers.py b/packages/api-server/api_server/routes/dispensers.py index c971121ae..d601e0a58 100644 --- a/packages/api-server/api_server/routes/dispensers.py +++ b/packages/api-server/api_server/routes/dispensers.py @@ -2,6 +2,7 @@ from fastapi import Depends, HTTPException from rx import operators as rxops +from rx.subject.replaysubject import ReplaySubject from api_server.dependencies import sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest @@ -34,10 +35,11 @@ async def get_dispenser_state( async def sub_dispenser_state(req: SubscriptionRequest, guid: str): user = sio_user(req) dispenser_state = await get_dispenser_state(guid, RmfRepository(user)) - await req.sio.emit(req.room, dispenser_state, req.sid) - return rmf_events.dispenser_states.pipe( - rxops.filter(lambda x: cast(DispenserState, x).guid == guid) - ) + sub = ReplaySubject(1) + if dispenser_state: + sub.on_next(dispenser_state) + rmf_events.dispenser_states.subscribe(sub) + return sub @router.get("/{guid}/health", response_model=DispenserHealth) diff --git a/packages/api-server/api_server/routes/doors.py b/packages/api-server/api_server/routes/doors.py index cacf0eeb9..998d246ce 100644 --- a/packages/api-server/api_server/routes/doors.py +++ b/packages/api-server/api_server/routes/doors.py @@ -2,6 +2,7 @@ from fastapi import Depends, HTTPException from rx import operators as rxops +from rx.subject.replaysubject import ReplaySubject from api_server.dependencies import sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest @@ -35,10 +36,11 @@ async def get_door_state( async def sub_door_state(req: SubscriptionRequest, door_name: str): user = sio_user(req) door_state = await get_door_state(door_name, RmfRepository(user)) - await req.sio.emit(req.room, door_state, req.sid) - return rmf_events.door_states.pipe( - rxops.filter(lambda x: cast(DoorState, x).door_name == door_name) - ) + sub = ReplaySubject(1) + if door_name: + sub.on_next(door_state) + rmf_events.door_states.subscribe(sub) + return sub @router.get("/{door_name}/health", response_model=DoorHealth) diff --git a/packages/api-server/api_server/routes/fleets.py b/packages/api-server/api_server/routes/fleets.py index 324f6a9b1..cf0fe20bf 100644 --- a/packages/api-server/api_server/routes/fleets.py +++ b/packages/api-server/api_server/routes/fleets.py @@ -2,6 +2,7 @@ from fastapi import Depends, HTTPException, Query from rx import operators as rxops +from rx.subject.replaysubject import ReplaySubject from api_server.dependencies import pagination_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest @@ -44,10 +45,11 @@ async def get_fleet_state(name: str, repo: FleetRepository = Depends(fleet_repo_ async def sub_fleet_state(req: SubscriptionRequest, name: str): user = sio_user(req) fleet_state = await get_fleet_state(name, FleetRepository(user)) - await req.sio.emit(req.room, fleet_state, req.sid) - return fleet_events.fleet_states.pipe( - rxops.filter(lambda x: cast(FleetState, x).name == name) - ) + sub = ReplaySubject(1) + if fleet_state: + sub.on_next(fleet_state) + fleet_events.fleet_states.subscribe(sub) + return sub @router.get("/{name}/log", response_model=FleetLog) @@ -65,7 +67,8 @@ async def get_fleet_log(name: str, repo: FleetRepository = Depends(fleet_repo_de async def sub_fleet_log(req: SubscriptionRequest, name: str): user = sio_user(req) fleet_log = await get_fleet_log(name, FleetRepository(user)) - await req.sio.emit(req.room, fleet_log, req.sid) - return fleet_events.fleet_logs.pipe( - rxops.filter(lambda x: cast(FleetLog, x).name == name) - ) + sub = ReplaySubject(1) + if fleet_log: + sub.on_next(fleet_log) + fleet_events.fleet_logs.subscribe(sub) + return sub diff --git a/packages/api-server/api_server/routes/ingestors.py b/packages/api-server/api_server/routes/ingestors.py index 55aed6bc6..5dedfd12f 100644 --- a/packages/api-server/api_server/routes/ingestors.py +++ b/packages/api-server/api_server/routes/ingestors.py @@ -2,6 +2,7 @@ from fastapi import Depends, HTTPException from rx import operators as rxops +from rx.subject.replaysubject import ReplaySubject from api_server.dependencies import sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest @@ -34,10 +35,11 @@ async def get_ingestor_state( async def sub_ingestor_state(req: SubscriptionRequest, guid: str): user = sio_user(req) ingestor_state = await get_ingestor_state(guid, RmfRepository(user)) - await req.sio.emit(req.room, ingestor_state, req.sid) - return rmf_events.ingestor_states.pipe( - rxops.filter(lambda x: cast(IngestorState, x).guid == guid) - ) + sub = ReplaySubject(1) + if ingestor_state: + sub.on_next(ingestor_state) + rmf_events.dispenser_states.subscribe(sub) + return sub @router.get("/{guid}/health", response_model=IngestorHealth) diff --git a/packages/api-server/api_server/routes/lifts.py b/packages/api-server/api_server/routes/lifts.py index 935dd7948..4ec3d0818 100644 --- a/packages/api-server/api_server/routes/lifts.py +++ b/packages/api-server/api_server/routes/lifts.py @@ -2,6 +2,7 @@ from fastapi import Depends, HTTPException from rx import operators as rxops +from rx.subject.replaysubject import ReplaySubject from api_server.dependencies import sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest @@ -35,10 +36,11 @@ async def get_lift_state( async def sub_lift_state(req: SubscriptionRequest, lift_name: str): user = sio_user(req) lift_state = await get_lift_state(lift_name, RmfRepository(user)) - await req.sio.emit(req.room, lift_state, req.sid) - return rmf_events.lift_states.pipe( - rxops.filter(lambda x: cast(LiftState, x).lift_name == lift_name) - ) + sub = ReplaySubject(1) + if lift_state: + sub.on_next(lift_state) + rmf_events.lift_states.subscribe(sub) + return sub @router.get("/{lift_name}/health", response_model=LiftHealth) diff --git a/packages/api-server/api_server/routes/test_dispensers.py b/packages/api-server/api_server/routes/test_dispensers.py index 6d0169514..b6c2c9ded 100644 --- a/packages/api-server/api_server/routes/test_dispensers.py +++ b/packages/api-server/api_server/routes/test_dispensers.py @@ -34,6 +34,5 @@ def test_get_dispenser_state(self): def test_sub_dispenser_state(self): fut = self.subscribe_sio(f"/dispensers/{self.dispenser_states[0].guid}/state") - try_until(fut.done, lambda x: x) - result = fut.result(0) + result = fut.result(1) self.assertEqual(self.dispenser_states[0].guid, result["guid"]) From 844b006d7162c4b250f2a5b01a4a88dffda87341 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 5 Jan 2022 06:09:27 +0000 Subject: [PATCH 11/79] fix lint errors Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/routes/fleets.py | 3 +-- packages/api-server/api_server/routes/test_dispensers.py | 2 +- packages/api-server/api_server/routes/test_doors.py | 4 +--- packages/api-server/api_server/routes/test_fleets.py | 8 +++----- packages/api-server/api_server/routes/test_ingestors.py | 5 ++--- packages/api-server/api_server/routes/test_lifts.py | 5 ++--- 6 files changed, 10 insertions(+), 17 deletions(-) diff --git a/packages/api-server/api_server/routes/fleets.py b/packages/api-server/api_server/routes/fleets.py index cf0fe20bf..b77e0ab4b 100644 --- a/packages/api-server/api_server/routes/fleets.py +++ b/packages/api-server/api_server/routes/fleets.py @@ -1,7 +1,6 @@ -from typing import List, Optional, cast +from typing import List, Optional from fastapi import Depends, HTTPException, Query -from rx import operators as rxops from rx.subject.replaysubject import ReplaySubject from api_server.dependencies import pagination_query, sio_user diff --git a/packages/api-server/api_server/routes/test_dispensers.py b/packages/api-server/api_server/routes/test_dispensers.py index b6c2c9ded..0d35dac25 100644 --- a/packages/api-server/api_server/routes/test_dispensers.py +++ b/packages/api-server/api_server/routes/test_dispensers.py @@ -1,7 +1,7 @@ from typing import List from uuid import uuid4 -from api_server.test import AppFixture, make_dispenser_state, try_until +from api_server.test import AppFixture, make_dispenser_state class TestDispensersRoute(AppFixture): diff --git a/packages/api-server/api_server/routes/test_doors.py b/packages/api-server/api_server/routes/test_doors.py index 600a4f7e4..7fecdbcb5 100644 --- a/packages/api-server/api_server/routes/test_doors.py +++ b/packages/api-server/api_server/routes/test_doors.py @@ -3,7 +3,6 @@ from rmf_door_msgs.msg import DoorMode as RmfDoorMode from api_server.test import AppFixture, make_building_map, make_door_state -from api_server.test.test_fixtures import try_until class TestDoorsRoute(AppFixture): @@ -35,8 +34,7 @@ def test_get_door_state(self): def test_sub_door_state(self): fut = self.subscribe_sio(f"/doors/{self.door_states[0].door_name}/state") - try_until(fut.done, lambda x: x) - result = fut.result(0) + result = fut.result(1) self.assertEqual(self.door_states[0].door_name, result["door_name"]) def test_post_door_request(self): diff --git a/packages/api-server/api_server/routes/test_fleets.py b/packages/api-server/api_server/routes/test_fleets.py index 6c0e13799..7088297df 100644 --- a/packages/api-server/api_server/routes/test_fleets.py +++ b/packages/api-server/api_server/routes/test_fleets.py @@ -1,6 +1,6 @@ from uuid import uuid4 -from api_server.test import AppFixture, make_fleet_log, make_fleet_state, try_until +from api_server.test import AppFixture, make_fleet_log, make_fleet_state class TestFleetsRoute(AppFixture): @@ -34,8 +34,7 @@ def test_get_fleet_state(self): def test_sub_fleet_state(self): fut = self.subscribe_sio(f"/fleets/{self.fleet_states[0].name}/state") - try_until(fut.done, lambda x: x) - result = fut.result(0) + result = fut.result(1) self.assertEqual(self.fleet_states[0].name, result["name"]) def test_get_fleet_log(self): @@ -46,6 +45,5 @@ def test_get_fleet_log(self): def test_sub_fleet_log(self): fut = self.subscribe_sio(f"/fleets/{self.fleet_states[0].name}/log") - try_until(fut.done, lambda x: x) - result = fut.result(0) + result = fut.result(1) self.assertEqual(self.fleet_logs[0].name, result["name"]) diff --git a/packages/api-server/api_server/routes/test_ingestors.py b/packages/api-server/api_server/routes/test_ingestors.py index af94552e4..5c22fbfe5 100644 --- a/packages/api-server/api_server/routes/test_ingestors.py +++ b/packages/api-server/api_server/routes/test_ingestors.py @@ -1,7 +1,7 @@ from typing import List from uuid import uuid4 -from api_server.test import AppFixture, make_ingestor_state, try_until +from api_server.test import AppFixture, make_ingestor_state class TestIngestorsRoute(AppFixture): @@ -34,6 +34,5 @@ def test_get_ingestor_state(self): def test_sub_ingestor_state(self): fut = self.subscribe_sio(f"/ingestors/{self.ingestor_states[0].guid}/state") - try_until(fut.done, lambda x: x) - result = fut.result(0) + result = fut.result(1) self.assertEqual(self.ingestor_states[0].guid, result["guid"]) diff --git a/packages/api-server/api_server/routes/test_lifts.py b/packages/api-server/api_server/routes/test_lifts.py index 2c0f344a4..1585e3604 100644 --- a/packages/api-server/api_server/routes/test_lifts.py +++ b/packages/api-server/api_server/routes/test_lifts.py @@ -2,7 +2,7 @@ from rmf_lift_msgs.msg import LiftRequest as RmfLiftRequest -from api_server.test import AppFixture, make_building_map, make_lift_state, try_until +from api_server.test import AppFixture, make_building_map, make_lift_state class TestLiftsRoute(AppFixture): @@ -34,8 +34,7 @@ def test_get_lift_state(self): def test_sub_lift_state(self): fut = self.subscribe_sio(f"/lifts/{self.lift_states[0].lift_name}/state") - try_until(fut.done, lambda x: x) - result = fut.result(0) + result = fut.result(1) self.assertEqual(self.lift_states[0].lift_name, result["lift_name"]) def test_request_lift(self): From 9b0a6ebbc12d9ab58d6f0af9e5feae69d54ef4e5 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 6 Jan 2022 02:45:07 +0000 Subject: [PATCH 12/79] make log enums compatible with pydantic Signed-off-by: Teo Koon Peng --- .../api-server/api_server/models/__init__.py | 1 - .../api-server/api_server/models/fleets.py | 34 +++++++++++++------ packages/api-server/api_server/models/log.py | 13 ------- .../models/tortoise_models/__init__.py | 4 +-- .../models/tortoise_models/fleets.py | 33 ++++++++++++++++-- .../api_server/models/tortoise_models/log.py | 9 ++--- .../api_server/repositories/tasks.py | 8 ++--- 7 files changed, 61 insertions(+), 41 deletions(-) delete mode 100644 packages/api-server/api_server/models/log.py diff --git a/packages/api-server/api_server/models/__init__.py b/packages/api-server/api_server/models/__init__.py index 295bd96a9..52583366e 100644 --- a/packages/api-server/api_server/models/__init__.py +++ b/packages/api-server/api_server/models/__init__.py @@ -6,7 +6,6 @@ from .health import * from .ingestors import * from .lifts import * -from .log import LogEntry from .pagination import * from .rmf_api.cancel_task_request import CancelTaskRequest from .rmf_api.cancel_task_response import TaskCancelResponse diff --git a/packages/api-server/api_server/models/fleets.py b/packages/api-server/api_server/models/fleets.py index 0c20225c5..1c59aa770 100644 --- a/packages/api-server/api_server/models/fleets.py +++ b/packages/api-server/api_server/models/fleets.py @@ -1,8 +1,12 @@ +from typing import Sequence + +from tortoise.transactions import in_transaction + +from . import tortoise_models as ttm from .rmf_api.fleet_log import FleetState as BaseFleetLog from .rmf_api.fleet_state import FleetState as BaseFleetState +from .rmf_api.log_entry import LogEntry from .ros_pydantic import rmf_fleet_msgs -from .tortoise_models import FleetLog as DbFleetLog -from .tortoise_models import FleetState as DbFleetState RobotMode = rmf_fleet_msgs.RobotMode Location = rmf_fleet_msgs.Location @@ -10,11 +14,11 @@ class FleetState(BaseFleetState): @staticmethod - def from_db(fleet_state: DbFleetState) -> "FleetState": + def from_db(fleet_state: ttm.FleetState) -> "FleetState": return FleetState(**fleet_state.data) async def save(self) -> None: - await DbFleetState.update_or_create( + await ttm.FleetState.update_or_create( { "data": self.json(), }, @@ -23,12 +27,20 @@ async def save(self) -> None: class FleetLog(BaseFleetLog): - @staticmethod - def from_db(fleet_log: DbFleetLog) -> "FleetLog": - return FleetLog(**fleet_log.data) + async def _saveFleetLogs( + self, db_fleet_log: ttm.FleetLog, logs: Sequence[LogEntry] + ): + for log in logs: + await ttm.FleetLogLog.create( + fleet=db_fleet_log, + seq=log.seq, + unix_millis_time=log.unix_millis_time, + tier=log.tier.name, + text=log.text, + ) async def save(self) -> None: - await DbFleetLog.update_or_create( - {"data": self.json()}, - name=self.name, - ) + async with in_transaction(): + db_fleet_log = (await ttm.FleetLog.get_or_create(name=self.name))[0] + if self.log: + await self._saveFleetLogs(db_fleet_log, self.log) diff --git a/packages/api-server/api_server/models/log.py b/packages/api-server/api_server/models/log.py deleted file mode 100644 index e7211e497..000000000 --- a/packages/api-server/api_server/models/log.py +++ /dev/null @@ -1,13 +0,0 @@ -from .rmf_api.log_entry import LogEntry as BaseLogEntry -from .tortoise_models import LogMixin - - -class LogEntry(BaseLogEntry): - @staticmethod - def from_tortoise(tortoise_log: LogMixin): - return LogEntry.construct( - seq=tortoise_log.seq, - unix_millis_time=tortoise_log.unix_millis_time, - tier=tortoise_log.tier.name, - text=tortoise_log.text, - ) diff --git a/packages/api-server/api_server/models/tortoise_models/__init__.py b/packages/api-server/api_server/models/tortoise_models/__init__.py index 3082c0976..afb345eef 100644 --- a/packages/api-server/api_server/models/tortoise_models/__init__.py +++ b/packages/api-server/api_server/models/tortoise_models/__init__.py @@ -2,7 +2,7 @@ from .building_map import BuildingMap from .dispenser_state import DispenserState from .door_state import DoorState -from .fleets import FleetLog, FleetState +from .fleets import FleetLog, FleetLogLog, FleetLogRobots, FleetLogRobotsLog, FleetState from .health import ( BasicHealthModel, DispenserHealth, @@ -13,7 +13,7 @@ ) from .ingestor_state import IngestorState from .lift_state import LiftState -from .log import LogEntryTier, LogMixin +from .log import LogMixin from .tasks import ( TaskEventLog, TaskEventLogLog, diff --git a/packages/api-server/api_server/models/tortoise_models/fleets.py b/packages/api-server/api_server/models/tortoise_models/fleets.py index 8ba1c6880..dacbdbe49 100644 --- a/packages/api-server/api_server/models/tortoise_models/fleets.py +++ b/packages/api-server/api_server/models/tortoise_models/fleets.py @@ -1,6 +1,14 @@ -from tortoise.fields import CharField, JSONField +from tortoise.fields import ( + CharField, + ForeignKeyField, + ForeignKeyRelation, + JSONField, + ReverseRelation, +) from tortoise.models import Model +from .log import LogMixin + class FleetState(Model): name = CharField(255, pk=True) @@ -9,4 +17,25 @@ class FleetState(Model): class FleetLog(Model): name = CharField(255, pk=True) - data = JSONField() + log: ReverseRelation["FleetLogLog"] + robots: ReverseRelation["FleetLogRobots"] + + +class FleetLogLog(Model, LogMixin): + fleet: ForeignKeyRelation[FleetLog] = ForeignKeyField("models.FleetLog", related_name="log") # type: ignore + + class Meta: + unique_together = ("fleet", "seq") + + +class FleetLogRobots(Model): + fleet: ForeignKeyRelation[FleetLog] = ForeignKeyField("models.FleetLog", related_name="robots") # type: ignore + robot = CharField(255) + log: ReverseRelation["FleetLogRobotsLog"] + + +class FleetLogRobotsLog(Model, LogMixin): + robot: ForeignKeyRelation[FleetLogRobots] = ForeignKeyField("models.FleetLogRobots", related_name="log") # type: ignore + + class Meta: + unique_together = ("id", "seq") diff --git a/packages/api-server/api_server/models/tortoise_models/log.py b/packages/api-server/api_server/models/tortoise_models/log.py index eb771f40e..7f6f30344 100644 --- a/packages/api-server/api_server/models/tortoise_models/log.py +++ b/packages/api-server/api_server/models/tortoise_models/log.py @@ -2,16 +2,11 @@ from tortoise.fields import CharEnumField, IntField, TextField - -class LogEntryTier(Enum): - uninitialized = "uninitialized" - info = "info" - warning = "warning" - error = "error" +from api_server.models.rmf_api import log_entry class LogMixin: seq = IntField() unix_millis_time = IntField(null=False, index=True) - tier = CharEnumField(LogEntryTier, max_length=255) + tier = CharEnumField(log_entry.Tier, max_length=255) text = TextField() diff --git a/packages/api-server/api_server/repositories/tasks.py b/packages/api-server/api_server/repositories/tasks.py index eb2a564cb..fda24c86f 100644 --- a/packages/api-server/api_server/repositories/tasks.py +++ b/packages/api-server/api_server/repositories/tasks.py @@ -62,17 +62,15 @@ async def get_task_log( phases = {} for db_phase in result.phases: phase = {} - phase["log"] = [LogEntry.from_tortoise(x) for x in db_phase.log] + phase["log"] = [LogEntry(**dict(x)) for x in db_phase.log] events = {} for db_event in db_phase.events: - events[db_event.event] = [ - LogEntry.from_tortoise(x) for x in db_event.log - ] + events[db_event.event] = [LogEntry(**dict(x)) for x in db_event.log] phase["events"] = events phases[db_phase.phase] = phase return TaskEventLog.construct( task_id=result.task_id, - log=[LogEntry.from_tortoise(x) for x in result.log], + log=[LogEntry(**dict(x)) for x in result.log], phases=phases, ) From cb70b95c6c7731e4c7dfedd4e588d1ae326e60bf Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 6 Jan 2022 03:18:40 +0000 Subject: [PATCH 13/79] move fleet logs to proper relational schema Signed-off-by: Teo Koon Peng --- .../api-server/api_server/dependencies.py | 29 +++++++++++- packages/api-server/api_server/logger.py | 4 ++ .../api-server/api_server/models/fleets.py | 10 +++- .../api-server/api_server/models/tasks.py | 4 +- .../models/tortoise_models/fleets.py | 2 +- .../api_server/models/tortoise_models/log.py | 2 - .../api_server/repositories/fleets.py | 46 +++++++++++++++---- .../api-server/api_server/rmf_gateway_app.py | 20 +------- .../api-server/api_server/routes/fleets.py | 25 +++++----- .../api_server/routes/tasks/tasks.py | 27 ++--------- .../api_server/routes/test_fleets.py | 14 ++++-- 11 files changed, 107 insertions(+), 76 deletions(-) diff --git a/packages/api-server/api_server/dependencies.py b/packages/api-server/api_server/dependencies.py index 14f877810..8a37ebac1 100644 --- a/packages/api-server/api_server/dependencies.py +++ b/packages/api-server/api_server/dependencies.py @@ -1,6 +1,8 @@ -from typing import Optional +from typing import Optional, Tuple -from fastapi import Query +from fastapi import Depends, Query + +from api_server import clock from .fast_io import SubscriptionRequest from .models import Pagination, User @@ -20,3 +22,26 @@ def pagination_query( # hacky way to get the sio user def sio_user(req: SubscriptionRequest) -> User: return req.session["user"] + + +def between_query( + between: str = Query( + "-60000", + description=""" + The period of time to fetch, in unix millis. + + This can be either a comma separated string or a string prefixed with '-' to fetch the last X millis. + + Example: + "1000,2000" - Fetches logs between unix millis 1000 and 2000. + "-60000" - Fetches logs in the last minute. + """, + ), + now: int = Depends(clock.now), +) -> Tuple[int, int]: + if between.startswith("-"): + period = (now - int(between[1:]), now) + else: + parts = between.split(",") + period = (int(parts[0]), int(parts[1])) + return period diff --git a/packages/api-server/api_server/logger.py b/packages/api-server/api_server/logger.py index 482e71afe..6dd1d6d87 100644 --- a/packages/api-server/api_server/logger.py +++ b/packages/api-server/api_server/logger.py @@ -12,3 +12,7 @@ logger.addHandler(handler) logger.setLevel(app_config.log_level) logger.name = "app" + + +def format_exception(exception: Exception): + return logger.error(f"{type(exception).__name__}:{exception}") diff --git a/packages/api-server/api_server/models/fleets.py b/packages/api-server/api_server/models/fleets.py index 1c59aa770..352123a06 100644 --- a/packages/api-server/api_server/models/fleets.py +++ b/packages/api-server/api_server/models/fleets.py @@ -1,7 +1,10 @@ from typing import Sequence +from tortoise.exceptions import IntegrityError from tortoise.transactions import in_transaction +from api_server.logger import format_exception, logger + from . import tortoise_models as ttm from .rmf_api.fleet_log import FleetState as BaseFleetLog from .rmf_api.fleet_state import FleetState as BaseFleetState @@ -42,5 +45,8 @@ async def _saveFleetLogs( async def save(self) -> None: async with in_transaction(): db_fleet_log = (await ttm.FleetLog.get_or_create(name=self.name))[0] - if self.log: - await self._saveFleetLogs(db_fleet_log, self.log) + try: + if self.log: + await self._saveFleetLogs(db_fleet_log, self.log) + except IntegrityError as e: + logger.error(format_exception(e)) diff --git a/packages/api-server/api_server/models/tasks.py b/packages/api-server/api_server/models/tasks.py index 8db4b52a6..f50cbac82 100644 --- a/packages/api-server/api_server/models/tasks.py +++ b/packages/api-server/api_server/models/tasks.py @@ -4,7 +4,7 @@ from tortoise.exceptions import IntegrityError from tortoise.transactions import in_transaction -from api_server.logger import logger +from api_server.logger import format_exception, logger from . import tortoise_models as ttm from .rmf_api.log_entry import LogEntry @@ -86,4 +86,4 @@ async def save(self) -> None: if self.phases: await self._savePhaseLogs(db_task_log, self.phases) except IntegrityError as e: - logger.error(f"{type(e).__name__}:{e}") + logger.error(format_exception(e)) diff --git a/packages/api-server/api_server/models/tortoise_models/fleets.py b/packages/api-server/api_server/models/tortoise_models/fleets.py index dacbdbe49..f50569856 100644 --- a/packages/api-server/api_server/models/tortoise_models/fleets.py +++ b/packages/api-server/api_server/models/tortoise_models/fleets.py @@ -30,7 +30,7 @@ class Meta: class FleetLogRobots(Model): fleet: ForeignKeyRelation[FleetLog] = ForeignKeyField("models.FleetLog", related_name="robots") # type: ignore - robot = CharField(255) + name = CharField(255) log: ReverseRelation["FleetLogRobotsLog"] diff --git a/packages/api-server/api_server/models/tortoise_models/log.py b/packages/api-server/api_server/models/tortoise_models/log.py index 7f6f30344..b6208d657 100644 --- a/packages/api-server/api_server/models/tortoise_models/log.py +++ b/packages/api-server/api_server/models/tortoise_models/log.py @@ -1,5 +1,3 @@ -from enum import Enum - from tortoise.fields import CharEnumField, IntField, TextField from api_server.models.rmf_api import log_entry diff --git a/packages/api-server/api_server/repositories/fleets.py b/packages/api-server/api_server/repositories/fleets.py index 2f1674819..341e85ef5 100644 --- a/packages/api-server/api_server/repositories/fleets.py +++ b/packages/api-server/api_server/repositories/fleets.py @@ -1,12 +1,12 @@ -from typing import List, Optional +from typing import List, Optional, Tuple, cast from fastapi import Depends +from tortoise.query_utils import Prefetch from tortoise.queryset import QuerySet from api_server.authenticator import user_dep -from api_server.models import FleetLog, FleetState, Pagination, User -from api_server.models.tortoise_models import FleetLog as DbFleetLog -from api_server.models.tortoise_models import FleetState as DbFleetState +from api_server.models import FleetLog, FleetState, LogEntry, Pagination, User +from api_server.models import tortoise_models as ttm from api_server.query import add_pagination @@ -15,7 +15,7 @@ def __init__(self, user: User): self.user = user async def query_fleet_states( - self, query: QuerySet[DbFleetState], pagination: Optional[Pagination] = None + self, query: QuerySet[ttm.FleetState], pagination: Optional[Pagination] = None ) -> List[FleetState]: # TODO: enforce with authz if pagination: @@ -25,16 +25,44 @@ async def query_fleet_states( async def get_fleet_state(self, name: str) -> Optional[FleetState]: # TODO: enforce with authz - result = await DbFleetState.get_or_none(name=name) + result = await ttm.FleetState.get_or_none(name=name) if result is None: return None return FleetState(**result.data) - async def get_fleet_log(self, name: str) -> Optional[FleetLog]: - result = await DbFleetLog.get_or_none(name=name) + async def get_fleet_log( + self, name: str, between: Tuple[int, int] + ) -> Optional[FleetLog]: + """ + :param between: The period in unix millis to fetch. + """ + between_filters = { + "unix_millis_time__gte": between[0], + "unix_millis_time__lte": between[1], + } + result = cast( + Optional[ttm.FleetLog], + await ttm.FleetLog.get_or_none(name=name).prefetch_related( + Prefetch( + "log", + ttm.FleetLogLog.filter(**between_filters), + ), + Prefetch( + "robots__log", ttm.FleetLogRobotsLog.filter(**between_filters) + ), + ), + ) if result is None: return None - return FleetLog(**result.data) + robots = {} + for db_robot in result.robots: + robot = [LogEntry(**dict(db_log)) for db_log in db_robot.log] + robots[db_robot.name] = robot + return FleetLog.construct( + name=result.name, + log=[LogEntry(**dict(db_log)) for db_log in result.log], + robots=robots, + ) def fleet_repo_dep(user: User = Depends(user_dep)): diff --git a/packages/api-server/api_server/rmf_gateway_app.py b/packages/api-server/api_server/rmf_gateway_app.py index ab08cb03d..a25bb1869 100644 --- a/packages/api-server/api_server/rmf_gateway_app.py +++ b/packages/api-server/api_server/rmf_gateway_app.py @@ -5,7 +5,6 @@ from fastapi import FastAPI, WebSocket, WebSocketDisconnect from . import models as mdl -from .models import tortoise_models as dbmdl from .rmf_io import fleet_events, task_events app = FastAPI() @@ -32,24 +31,7 @@ async def process_msg(msg: Dict[str, Any]) -> None: fleet_events.fleet_states.on_next(fleet_state) elif payload_type == "fleet_log_update": fleet_log = mdl.FleetLog.construct(**msg["data"]) - current_log = mdl.FleetLog.from_db( - ( - await dbmdl.FleetLog.get_or_create( - {"data": fleet_log.json()}, name=fleet_log.name - ) - )[0] - ) - if fleet_log.log: - if current_log.log is None: - current_log.log = [] - current_log.log.extend(fleet_log.log) - if fleet_log.robots: - if current_log.robots is None: - current_log.robots = {} - for robot_name, robot in fleet_log.robots.items(): - current_robot = current_log.robots.setdefault(robot_name, []) - current_robot.extend(robot) - await current_log.save() + await fleet_log.save() fleet_events.fleet_logs.on_next(fleet_log) diff --git a/packages/api-server/api_server/routes/fleets.py b/packages/api-server/api_server/routes/fleets.py index b77e0ab4b..c84715fa1 100644 --- a/packages/api-server/api_server/routes/fleets.py +++ b/packages/api-server/api_server/routes/fleets.py @@ -1,9 +1,10 @@ -from typing import List, Optional +from typing import List, Optional, Tuple, cast from fastapi import Depends, HTTPException, Query +from rx import operators as rxops from rx.subject.replaysubject import ReplaySubject -from api_server.dependencies import pagination_query, sio_user +from api_server.dependencies import between_query, pagination_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest from api_server.models import FleetLog, FleetState, Pagination from api_server.models.tortoise_models import FleetState as DbFleetState @@ -52,22 +53,22 @@ async def sub_fleet_state(req: SubscriptionRequest, name: str): @router.get("/{name}/log", response_model=FleetLog) -async def get_fleet_log(name: str, repo: FleetRepository = Depends(fleet_repo_dep)): +async def get_fleet_log( + name: str, + repo: FleetRepository = Depends(fleet_repo_dep), + between: Tuple[int, int] = Depends(between_query), +): """ Available in socket.io """ - fleet_log = await repo.get_fleet_log(name) + fleet_log = await repo.get_fleet_log(name, between) if fleet_log is None: raise HTTPException(status_code=404) return fleet_log @router.sub("/{name}/log", response_model=FleetLog) -async def sub_fleet_log(req: SubscriptionRequest, name: str): - user = sio_user(req) - fleet_log = await get_fleet_log(name, FleetRepository(user)) - sub = ReplaySubject(1) - if fleet_log: - sub.on_next(fleet_log) - fleet_events.fleet_logs.subscribe(sub) - return sub +async def sub_fleet_log(_req: SubscriptionRequest, name: str): + return fleet_events.fleet_logs.pipe( + rxops.filter(lambda x: cast(FleetLog, x).name == name) + ) diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index c7ff60963..33c308529 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -1,13 +1,12 @@ from datetime import datetime -from typing import List, Optional, cast +from typing import List, Optional, Tuple, cast from fastapi import Body, Depends, HTTPException, Path, Query from rx import operators as rxops from rx.subject.replaysubject import ReplaySubject -from api_server import clock from api_server.authenticator import user_dep -from api_server.dependencies import pagination_query, sio_user +from api_server.dependencies import between_query, pagination_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest from api_server.models import ( CancelTaskRequest, @@ -81,29 +80,13 @@ async def sub_task_state(req: SubscriptionRequest, task_id: str): async def get_task_log( task_repo: TaskRepository = Depends(task_repo_dep), task_id: str = Path(..., description="task_id"), - between: str = Query( - "-60000", - description=""" - The period of time to fetch, in unix millis. - - This can be either a comma separated string or a string prefixed with '-' to fetch the last X millis. - - Example: - "1000,2000" - Fetches logs between unix millis 1000 and 2000. - "-60000" - Fetches logs in the last minute. - """, - ), - now: int = Depends(clock.now), + between: Tuple[int, int] = Depends(between_query), ): """ Available in socket.io """ - if between.startswith("-"): - period = (now - int(between[1:]), now) - else: - parts = between.split(",") - period = (int(parts[0]), int(parts[1])) - result = await task_repo.get_task_log(task_id, period) + + result = await task_repo.get_task_log(task_id, between) if result is None: raise HTTPException(status_code=404) return result diff --git a/packages/api-server/api_server/routes/test_fleets.py b/packages/api-server/api_server/routes/test_fleets.py index 7088297df..a6765ac89 100644 --- a/packages/api-server/api_server/routes/test_fleets.py +++ b/packages/api-server/api_server/routes/test_fleets.py @@ -1,5 +1,6 @@ from uuid import uuid4 +from api_server.rmf_io import fleet_events from api_server.test import AppFixture, make_fleet_log, make_fleet_state @@ -38,12 +39,15 @@ def test_sub_fleet_state(self): self.assertEqual(self.fleet_states[0].name, result["name"]) def test_get_fleet_log(self): - resp = self.session.get(f"/fleets/{self.fleet_states[0].name}/log") + # Since there are no sample fleet logs, we cannot check the log contents + resp = self.session.get(f"/fleets/{self.fleet_logs[0].name}/log") self.assertEqual(200, resp.status_code) - state = resp.json() - self.assertEqual(self.fleet_logs[0].name, state["name"]) + self.assertEqual(self.fleet_logs[0].name, resp.json()["name"]) def test_sub_fleet_log(self): - fut = self.subscribe_sio(f"/fleets/{self.fleet_states[0].name}/log") + fleet = f"fleet_{uuid4()}" + fut = self.subscribe_sio(f"/fleets/{fleet}/log") + fleet_logs = make_fleet_log(fleet) + fleet_events.fleet_logs.on_next(fleet_logs) result = fut.result(1) - self.assertEqual(self.fleet_logs[0].name, result["name"]) + self.assertEqual(fleet, result["name"]) From a1951220839facf49a4570658f5e51b9ac8b3228 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 6 Jan 2022 03:22:26 +0000 Subject: [PATCH 14/79] fix state updates not being filtered Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/routes/dispensers.py | 4 +++- packages/api-server/api_server/routes/doors.py | 4 +++- packages/api-server/api_server/routes/fleets.py | 4 +++- packages/api-server/api_server/routes/ingestors.py | 4 +++- packages/api-server/api_server/routes/lifts.py | 4 +++- packages/api-server/api_server/routes/tasks/tasks.py | 4 +++- 6 files changed, 18 insertions(+), 6 deletions(-) diff --git a/packages/api-server/api_server/routes/dispensers.py b/packages/api-server/api_server/routes/dispensers.py index d601e0a58..d0a238ab8 100644 --- a/packages/api-server/api_server/routes/dispensers.py +++ b/packages/api-server/api_server/routes/dispensers.py @@ -38,7 +38,9 @@ async def sub_dispenser_state(req: SubscriptionRequest, guid: str): sub = ReplaySubject(1) if dispenser_state: sub.on_next(dispenser_state) - rmf_events.dispenser_states.subscribe(sub) + rmf_events.dispenser_states.pipe( + rxops.filter(lambda x: cast(DispenserState, x).guid == guid) + ).subscribe(sub) return sub diff --git a/packages/api-server/api_server/routes/doors.py b/packages/api-server/api_server/routes/doors.py index 998d246ce..1147d0d6c 100644 --- a/packages/api-server/api_server/routes/doors.py +++ b/packages/api-server/api_server/routes/doors.py @@ -39,7 +39,9 @@ async def sub_door_state(req: SubscriptionRequest, door_name: str): sub = ReplaySubject(1) if door_name: sub.on_next(door_state) - rmf_events.door_states.subscribe(sub) + rmf_events.door_states.pipe( + rxops.filter(lambda x: cast(DoorState, x).door_name == door_name) + ).subscribe(sub) return sub diff --git a/packages/api-server/api_server/routes/fleets.py b/packages/api-server/api_server/routes/fleets.py index c84715fa1..f296b0782 100644 --- a/packages/api-server/api_server/routes/fleets.py +++ b/packages/api-server/api_server/routes/fleets.py @@ -48,7 +48,9 @@ async def sub_fleet_state(req: SubscriptionRequest, name: str): sub = ReplaySubject(1) if fleet_state: sub.on_next(fleet_state) - fleet_events.fleet_states.subscribe(sub) + fleet_events.fleet_states.pipe( + rxops.filter(lambda x: cast(FleetState, x).name == name) + ).subscribe(sub) return sub diff --git a/packages/api-server/api_server/routes/ingestors.py b/packages/api-server/api_server/routes/ingestors.py index 5dedfd12f..21975f95e 100644 --- a/packages/api-server/api_server/routes/ingestors.py +++ b/packages/api-server/api_server/routes/ingestors.py @@ -38,7 +38,9 @@ async def sub_ingestor_state(req: SubscriptionRequest, guid: str): sub = ReplaySubject(1) if ingestor_state: sub.on_next(ingestor_state) - rmf_events.dispenser_states.subscribe(sub) + rmf_events.ingestor_states.pipe( + rxops.filter(lambda x: cast(IngestorState, x).guid == guid) + ).subscribe(sub) return sub diff --git a/packages/api-server/api_server/routes/lifts.py b/packages/api-server/api_server/routes/lifts.py index 4ec3d0818..29902f00b 100644 --- a/packages/api-server/api_server/routes/lifts.py +++ b/packages/api-server/api_server/routes/lifts.py @@ -39,7 +39,9 @@ async def sub_lift_state(req: SubscriptionRequest, lift_name: str): sub = ReplaySubject(1) if lift_state: sub.on_next(lift_state) - rmf_events.lift_states.subscribe(sub) + rmf_events.lift_states.pipe( + rxops.filter(lambda x: cast(LiftState, x).lift_name == lift_name) + ).subscribe(sub) return sub diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index 33c308529..47306cbe1 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -72,7 +72,9 @@ async def sub_task_state(req: SubscriptionRequest, task_id: str): sub = ReplaySubject(1) if current_state: sub.on_next(current_state) - task_events.task_states.subscribe(sub) + task_events.task_states.pipe( + rxops.filter(lambda x: cast(TaskState, x).booking.id == task_id) + ).subscribe(sub) return sub From cc42ef75c1f5bdee3bf3f520095d81a28a6b0130 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 6 Jan 2022 03:26:36 +0000 Subject: [PATCH 15/79] fix race conditon in health subscriptions Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/routes/dispensers.py | 9 ++++++--- packages/api-server/api_server/routes/doors.py | 9 ++++++--- packages/api-server/api_server/routes/ingestors.py | 9 ++++++--- packages/api-server/api_server/routes/lifts.py | 11 +++++++---- 4 files changed, 25 insertions(+), 13 deletions(-) diff --git a/packages/api-server/api_server/routes/dispensers.py b/packages/api-server/api_server/routes/dispensers.py index d0a238ab8..ee7607f48 100644 --- a/packages/api-server/api_server/routes/dispensers.py +++ b/packages/api-server/api_server/routes/dispensers.py @@ -61,7 +61,10 @@ async def get_dispenser_health( async def sub_dispenser_health(req: SubscriptionRequest, guid: str): user = sio_user(req) health = await get_dispenser_health(guid, RmfRepository(user)) - await req.sio.emit(req.room, health, req.sid) - return rmf_events.dispenser_health.pipe( + sub = ReplaySubject(1) + if health: + sub.on_next(health) + rmf_events.dispenser_health.pipe( rxops.filter(lambda x: cast(DispenserHealth, x).id_ == guid) - ) + ).subscribe(sub) + return sub diff --git a/packages/api-server/api_server/routes/doors.py b/packages/api-server/api_server/routes/doors.py index 1147d0d6c..295a1758f 100644 --- a/packages/api-server/api_server/routes/doors.py +++ b/packages/api-server/api_server/routes/doors.py @@ -62,10 +62,13 @@ async def get_door_health( async def sub_door_health(req: SubscriptionRequest, door_name: str): user = sio_user(req) health = await get_door_health(door_name, RmfRepository(user)) - await req.sio.emit(req.room, health, req.sid) - return rmf_events.door_health.pipe( + sub = ReplaySubject(1) + if health: + sub.on_next(health) + rmf_events.door_health.pipe( rxops.filter(lambda x: cast(DoorHealth, x).id_ == door_name) - ) + ).subscribe(sub) + return sub @router.post("/{door_name}/request") diff --git a/packages/api-server/api_server/routes/ingestors.py b/packages/api-server/api_server/routes/ingestors.py index 21975f95e..98329867f 100644 --- a/packages/api-server/api_server/routes/ingestors.py +++ b/packages/api-server/api_server/routes/ingestors.py @@ -61,7 +61,10 @@ async def get_ingestor_health( async def sub_ingestor_health(req: SubscriptionRequest, guid: str): user = sio_user(req) health = await get_ingestor_health(guid, RmfRepository(user)) - await req.sio.emit(req.room, health, req.sid) - return rmf_events.ingestor_health.pipe( + sub = ReplaySubject(1) + if health: + sub.on_next(health) + rmf_events.ingestor_health.pipe( rxops.filter(lambda x: cast(IngestorHealth, x).id_ == guid) - ) + ).subscribe(sub) + return sub diff --git a/packages/api-server/api_server/routes/lifts.py b/packages/api-server/api_server/routes/lifts.py index 29902f00b..a774611d0 100644 --- a/packages/api-server/api_server/routes/lifts.py +++ b/packages/api-server/api_server/routes/lifts.py @@ -62,10 +62,13 @@ async def get_lift_health( async def sub_lift_health(req: SubscriptionRequest, lift_name: str): user = sio_user(req) health = await get_lift_health(lift_name, RmfRepository(user)) - await req.sio.emit(req.room, health, req.sid) - return rmf_events.lift_health.pipe( - rxops.filter(lambda x: cast(LiftHealth, x).id_ == lift_name), - ) + sub = ReplaySubject(1) + if health: + sub.on_next(health) + rmf_events.lift_health.pipe( + rxops.filter(lambda x: cast(LiftHealth, x).id_ == lift_name) + ).subscribe(sub) + return sub @router.post("/{lift_name}/request") From 4f6f459cb862e2e1e8dfcc44be7fc3b43c4ddcde Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 6 Jan 2022 06:47:01 +0000 Subject: [PATCH 16/79] cleanup Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/rmf_gateway_app.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/packages/api-server/api_server/rmf_gateway_app.py b/packages/api-server/api_server/rmf_gateway_app.py index a25bb1869..168345285 100644 --- a/packages/api-server/api_server/rmf_gateway_app.py +++ b/packages/api-server/api_server/rmf_gateway_app.py @@ -10,8 +10,6 @@ app = FastAPI() -# FIXME: Log updates are very inefficient because we are re-writing the entire logs -# on every update. More efficient solutions will require proper relational schemas. async def process_msg(msg: Dict[str, Any]) -> None: payload_type: str = msg["type"] if not isinstance(payload_type, str): @@ -22,7 +20,7 @@ async def process_msg(msg: Dict[str, Any]) -> None: await task_state.save() task_events.task_states.on_next(task_state) elif payload_type == "task_log_update": - task_log = mdl.TaskEventLog(**msg["data"]) + task_log = mdl.TaskEventLog.construct(**msg["data"]) await task_log.save() task_events.task_event_logs.on_next(task_log) elif payload_type == "fleet_state_update": From 0b8725dfbd19499a1d06ffc591a48e9be3afae92 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Fri, 7 Jan 2022 01:37:27 +0000 Subject: [PATCH 17/79] do not automatically source ros Signed-off-by: Teo Koon Peng --- scripts/rmf-helpers.sh | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/scripts/rmf-helpers.sh b/scripts/rmf-helpers.sh index 7da8f9459..b899f67b7 100644 --- a/scripts/rmf-helpers.sh +++ b/scripts/rmf-helpers.sh @@ -14,7 +14,10 @@ rmf_msgs=( # NOTE: This sources `/opt/ros/foxy/setup.bash``. check_rmf_not_sourced() { - . /opt/ros/foxy/setup.bash + if [[ -z $ROS_DISTRO ]]; then + echo 'Unable to find ros, make sure a supported ros distro is sourced.' + exit 1 + fi if ros2 pkg list | grep "^rmf_"; then echo 'One or more rmf packages is already found in your env, you probably have rmf sourced.' echo 'This may cause problems when generating the models, please run this script in a new terminal without rmf sourced.' From f639765801f5463535083e10c0363a89c165cd23 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Fri, 7 Jan 2022 01:40:36 +0000 Subject: [PATCH 18/79] clean dir before generating Signed-off-by: Teo Koon Peng --- packages/api-server/generate-models.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/api-server/generate-models.sh b/packages/api-server/generate-models.sh index 9b2cffc78..ac4838aaa 100755 --- a/packages/api-server/generate-models.sh +++ b/packages/api-server/generate-models.sh @@ -45,6 +45,7 @@ rmf_msgs=( 'rmf_fleet_msgs' 'rmf_task_msgs' ) +rm -rf api_server/models/ros_pydantic pipenv run ros_translator -t=pydantic -o=api_server/models/ros_pydantic "${rmf_msgs[@]}" cat << EOF > api_server/models/ros_pydantic/version.py @@ -67,6 +68,7 @@ if [[ ! -d .venv_local/lib ]]; then python3 -m venv .venv_local . .venv_local/bin/activate && pip3 install wheel && pip3 install 'datamodel-code-generator~=0.11.15' fi +rm -rf api_server/models/rmf_api . .venv_local/bin/activate && datamodel-codegen --disable-timestamp --input-file-type jsonschema --input build/rmf_api_msgs/rmf_api_msgs/schemas --output "$output" cat << EOF > "$output/version.py" # THIS FILE IS GENERATED From 39aa40e8ff317d3eadf1ecd514abe5d47542ee4a Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Fri, 7 Jan 2022 01:55:36 +0000 Subject: [PATCH 19/79] run datamodel-codegen in sub shell to avoid tainting the current shell Signed-off-by: Teo Koon Peng --- packages/api-server/generate-models.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/api-server/generate-models.sh b/packages/api-server/generate-models.sh index ac4838aaa..3171dbd3d 100755 --- a/packages/api-server/generate-models.sh +++ b/packages/api-server/generate-models.sh @@ -66,10 +66,10 @@ rm -rf "$output" mkdir -p "$output" if [[ ! -d .venv_local/lib ]]; then python3 -m venv .venv_local - . .venv_local/bin/activate && pip3 install wheel && pip3 install 'datamodel-code-generator~=0.11.15' + bash -c ". .venv_local/bin/activate && pip3 install wheel && pip3 install 'datamodel-code-generator~=0.11.15'" fi rm -rf api_server/models/rmf_api -. .venv_local/bin/activate && datamodel-codegen --disable-timestamp --input-file-type jsonschema --input build/rmf_api_msgs/rmf_api_msgs/schemas --output "$output" +bash -c ". .venv_local/bin/activate && datamodel-codegen --disable-timestamp --input-file-type jsonschema --input build/rmf_api_msgs/rmf_api_msgs/schemas --output \"$output\"" cat << EOF > "$output/version.py" # THIS FILE IS GENERATED version = { From ef655f217647cf252b6c2aea9eb764071efe2a16 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 10 Jan 2022 01:17:06 +0000 Subject: [PATCH 20/79] update models with fixed task logs Signed-off-by: Teo Koon Peng --- .../api-server/api_server/models/__init__.py | 1 + .../rmf_api/compose_task_description.py | 4 +- .../models/rmf_api/dispatch_task_request.py | 13 ++++++ .../models/rmf_api/dispatch_task_response.py | 30 +++++++++++++ .../api_server/models/rmf_api/robot_state.py | 4 +- .../api_server/models/rmf_api/task_log.py | 22 ++++++++-- .../api_server/models/rmf_api/task_request.py | 14 +++---- .../api_server/models/rmf_api/task_state.py | 42 +++++++++++++++++-- .../api_server/models/rmf_api/version.py | 2 +- .../builtin_interfaces/Duration.py | 5 ++- .../ros_pydantic/builtin_interfaces/Time.py | 3 +- .../api-server/api_server/models/tasks.py | 29 +++++++------ .../api-server/api_server/rmf_gateway_app.py | 8 ++-- .../api_server/routes/tasks/test_tasks.py | 32 +++++++------- packages/api-server/generate-models.sh | 2 +- 15 files changed, 157 insertions(+), 54 deletions(-) create mode 100644 packages/api-server/api_server/models/rmf_api/dispatch_task_request.py create mode 100644 packages/api-server/api_server/models/rmf_api/dispatch_task_response.py diff --git a/packages/api-server/api_server/models/__init__.py b/packages/api-server/api_server/models/__init__.py index 52583366e..172b6a699 100644 --- a/packages/api-server/api_server/models/__init__.py +++ b/packages/api-server/api_server/models/__init__.py @@ -9,6 +9,7 @@ from .pagination import * from .rmf_api.cancel_task_request import CancelTaskRequest from .rmf_api.cancel_task_response import TaskCancelResponse +from .rmf_api.log_entry import LogEntry, Tier from .rmf_api.task_request import TaskRequest from .tasks import TaskEventLog, TaskState from .user import * diff --git a/packages/api-server/api_server/models/rmf_api/compose_task_description.py b/packages/api-server/api_server/models/rmf_api/compose_task_description.py index fd45c404b..8bd56f07c 100644 --- a/packages/api-server/api_server/models/rmf_api/compose_task_description.py +++ b/packages/api-server/api_server/models/rmf_api/compose_task_description.py @@ -12,7 +12,7 @@ class ActivityDescription(BaseModel): category: str = Field(..., description="The category of this phase's activity.") -class Phase(BaseModel): +class Phase1(BaseModel): activity: ActivityDescription on_cancel: Optional[List[ActivityDescription]] = Field( None, @@ -24,7 +24,7 @@ class ComposeTaskDescription(BaseModel): category: str = Field( ..., description="Indicate that this is a composed task description" ) - phases: List[Phase] = Field( + phases: List[Phase1] = Field( ..., description="List the phases of the task in the order that they should be performed.", ) diff --git a/packages/api-server/api_server/models/rmf_api/dispatch_task_request.py b/packages/api-server/api_server/models/rmf_api/dispatch_task_request.py new file mode 100644 index 000000000..5a6d86f1f --- /dev/null +++ b/packages/api-server/api_server/models/rmf_api/dispatch_task_request.py @@ -0,0 +1,13 @@ +# generated by datamodel-codegen: +# filename: dispatch_task_request.json + +from __future__ import annotations + +from pydantic import BaseModel, Field + +from . import task_request + + +class DispatchTaskRequest(BaseModel): + type: str = Field(..., description="Indicate that this is a task dispatch request") + request: task_request.TaskRequest diff --git a/packages/api-server/api_server/models/rmf_api/dispatch_task_response.py b/packages/api-server/api_server/models/rmf_api/dispatch_task_response.py new file mode 100644 index 000000000..73c3fc95e --- /dev/null +++ b/packages/api-server/api_server/models/rmf_api/dispatch_task_response.py @@ -0,0 +1,30 @@ +# generated by datamodel-codegen: +# filename: dispatch_task_response.json + +from __future__ import annotations + +from typing import List, Optional, Union + +from pydantic import BaseModel, Field + +from . import error, task_state + + +class TaskDispatchResponseItem1(BaseModel): + success: Optional[bool] = None + errors: Optional[List[error.Error]] = Field( + None, description="Any error messages explaining why the request failed" + ) + + +class TaskDispatchResponseItem(BaseModel): + success: bool + state: Optional[task_state.TaskState] = None + + +class TaskDispatchResponse(BaseModel): + __root__: Union[TaskDispatchResponseItem, TaskDispatchResponseItem1] = Field( + ..., + description="Response to a task dispatch request", + title="Task Dispatch Response", + ) diff --git a/packages/api-server/api_server/models/rmf_api/robot_state.py b/packages/api-server/api_server/models/rmf_api/robot_state.py index 070b7b885..b16fff479 100644 --- a/packages/api-server/api_server/models/rmf_api/robot_state.py +++ b/packages/api-server/api_server/models/rmf_api/robot_state.py @@ -11,7 +11,7 @@ from . import location_2D -class Status(Enum): +class Status2(Enum): uninitialized = "uninitialized" offline = "offline" shutdown = "shutdown" @@ -30,7 +30,7 @@ class Issue(BaseModel): class RobotState(BaseModel): name: Optional[str] = None - status: Optional[Status] = Field( + status: Optional[Status2] = Field( None, description="A simple token representing the status of the robot" ) task_id: Optional[str] = Field( diff --git a/packages/api-server/api_server/models/rmf_api/task_log.py b/packages/api-server/api_server/models/rmf_api/task_log.py index 56888902d..9ff047d53 100644 --- a/packages/api-server/api_server/models/rmf_api/task_log.py +++ b/packages/api-server/api_server/models/rmf_api/task_log.py @@ -3,19 +3,35 @@ from __future__ import annotations -from typing import Any, Dict, List, Optional +from typing import Dict, List, Optional -from pydantic import BaseModel, Field +from pydantic import BaseModel, Extra, Field from . import log_entry +class Phases(BaseModel): + class Config: + extra = Extra.forbid + + log: Optional[List[log_entry.LogEntry]] = Field( + None, description="Log entries related to the overall phase" + ) + events: Optional[Dict[str, List[log_entry.LogEntry]]] = Field( + None, + description="A dictionary whose keys (property names) are the indices of an event in the phase", + ) + + class TaskEventLog(BaseModel): + class Config: + extra = Extra.forbid + task_id: str log: Optional[List[log_entry.LogEntry]] = Field( None, description="Log entries related to the overall task" ) - phases: Optional[Dict[str, Dict[str, Any]]] = Field( + phases: Optional[Dict[str, Phases]] = Field( None, description="A dictionary whose keys (property names) are the indices of a phase", ) diff --git a/packages/api-server/api_server/models/rmf_api/task_request.py b/packages/api-server/api_server/models/rmf_api/task_request.py index 7ed3d9db3..10a4df44b 100644 --- a/packages/api-server/api_server/models/rmf_api/task_request.py +++ b/packages/api-server/api_server/models/rmf_api/task_request.py @@ -3,15 +3,11 @@ from __future__ import annotations -from typing import Any, Dict, Optional +from typing import Any, Dict, List, Optional from pydantic import BaseModel, Field -class Description(BaseModel): - category: str - - class TaskRequest(BaseModel): unix_millis_earliest_start_time: Optional[int] = Field( None, description="(Optional) The earliest time that this task may start" @@ -20,7 +16,11 @@ class TaskRequest(BaseModel): None, description="(Optional) The priority of this task. This must match a priority schema supported by a fleet.", ) - description: Description = Field( + category: str + description: Any = Field( ..., - description="A description of the task. This must match a schema supported by a fleet.", + description="A description of the task. This must match a schema supported by a fleet for the category of this task request.", + ) + labels: Optional[List[str]] = Field( + None, description="Labels to describe the purpose of the task dispatch request" ) diff --git a/packages/api-server/api_server/models/rmf_api/task_state.py b/packages/api-server/api_server/models/rmf_api/task_state.py index 0378330ba..0494bccb5 100644 --- a/packages/api-server/api_server/models/rmf_api/task_state.py +++ b/packages/api-server/api_server/models/rmf_api/task_state.py @@ -8,6 +8,13 @@ from pydantic import BaseModel, Field, conint +from . import error + + +class AssignedTo(BaseModel): + group: str + name: str + class Cancellation(BaseModel): unix_millis_request_time: int = Field( @@ -44,6 +51,19 @@ class Detail(BaseModel): ) +class Status1(Enum): + queued = "queued" + selected = "selected" + dispatched = "dispatched" + failed_to_assign = "failed_to_assign" + canceled_in_flight = "canceled_in_flight" + + +class Assignment(BaseModel): + fleet_name: Optional[str] = None + expected_robot_name: Optional[str] = None + + class EstimateMillis(BaseModel): __root__: conint(ge=0) = Field( ..., @@ -75,11 +95,12 @@ class Interruption(BaseModel): ) -class Status1(Enum): +class Status(Enum): uninitialized = "uninitialized" blocked = "blocked" error = "error" failed = "failed" + queued = "queued" standby = "standby" underway = "underway" delayed = "delayed" @@ -91,9 +112,7 @@ class Status1(Enum): class EventState(BaseModel): id: Id - status: Optional[Status1] = Field( - None, description="A simple token representing how the task is proceeding" - ) + status: Optional[Status] = None name: Optional[str] = Field(None, description="The brief name of the event") detail: Optional[Detail] = Field( None, description="Detailed information about the event" @@ -126,10 +145,19 @@ class SkipPhaseRequest(BaseModel): ) +class Dispatch(BaseModel): + status: Status1 + assignment: Optional[Assignment] = None + errors: Optional[List[error.Error]] = None + + class Phase(BaseModel): id: Id category: Optional[Category] = None detail: Optional[Detail] = None + unix_millis_start_time: Optional[int] = None + unix_millis_finish_time: Optional[int] = None + original_estimate_millis: Optional[EstimateMillis] = None estimate_millis: Optional[EstimateMillis] = None final_event_id: Optional[Id] = None events: Optional[Dict[str, EventState]] = Field( @@ -147,7 +175,13 @@ class TaskState(BaseModel): detail: Optional[Detail] = None unix_millis_start_time: Optional[int] = None unix_millis_finish_time: Optional[int] = None + original_estimate_millis: Optional[EstimateMillis] = None estimate_millis: Optional[EstimateMillis] = None + assigned_to: Optional[AssignedTo] = Field( + None, description="Which agent (robot) is the task assigned to" + ) + status: Optional[Status] = None + dispatch: Optional[Dispatch] = None phases: Optional[Dict[str, Phase]] = Field( None, description="A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.", diff --git a/packages/api-server/api_server/models/rmf_api/version.py b/packages/api-server/api_server/models/rmf_api/version.py index 5782083f8..ad0095c51 100644 --- a/packages/api-server/api_server/models/rmf_api/version.py +++ b/packages/api-server/api_server/models/rmf_api/version.py @@ -1,4 +1,4 @@ # THIS FILE IS GENERATED version = { - "rmf_api_msgs": "2f20985a25279141fcb226402d67abfeb6db6944", + "rmf_api_msgs": "0f2d5082934acc56f8c352810f0f5db07103d788", } diff --git a/packages/api-server/api_server/models/ros_pydantic/builtin_interfaces/Duration.py b/packages/api-server/api_server/models/ros_pydantic/builtin_interfaces/Duration.py index 5576c2689..55c5efe14 100644 --- a/packages/api-server/api_server/models/ros_pydantic/builtin_interfaces/Duration.py +++ b/packages/api-server/api_server/models/ros_pydantic/builtin_interfaces/Duration.py @@ -19,8 +19,9 @@ class Config: } -# # Duration defines a period between two time points. It is comprised of a -# # seconds component and a nanoseconds component. +# # Duration defines a period between two time points. +# # Messages of this datatype are of ROS Time following this design: +# # https://design.ros2.org/articles/clock_and_time.html # # # Seconds component, range is valid over any possible int32 value. # int32 sec diff --git a/packages/api-server/api_server/models/ros_pydantic/builtin_interfaces/Time.py b/packages/api-server/api_server/models/ros_pydantic/builtin_interfaces/Time.py index 355918610..b0cdb8506 100644 --- a/packages/api-server/api_server/models/ros_pydantic/builtin_interfaces/Time.py +++ b/packages/api-server/api_server/models/ros_pydantic/builtin_interfaces/Time.py @@ -19,7 +19,8 @@ class Config: } -# # Time indicates a specific point in time, relative to a clock's 0 point. +# # This message communicates ROS Time defined here: +# # https://design.ros2.org/articles/clock_and_time.html # # # The seconds component, valid over all int32 values. # int32 sec diff --git a/packages/api-server/api_server/models/tasks.py b/packages/api-server/api_server/models/tasks.py index f50cbac82..80884f49b 100644 --- a/packages/api-server/api_server/models/tasks.py +++ b/packages/api-server/api_server/models/tasks.py @@ -1,5 +1,5 @@ from datetime import datetime -from typing import Any, Dict, Sequence +from typing import Dict, List, Sequence from tortoise.exceptions import IntegrityError from tortoise.transactions import in_transaction @@ -7,8 +7,8 @@ from api_server.logger import format_exception, logger from . import tortoise_models as ttm +from .rmf_api import task_log from .rmf_api.log_entry import LogEntry -from .rmf_api.task_log import TaskEventLog as BaseTaskEventLog from .rmf_api.task_state import TaskState as BaseTaskState @@ -31,11 +31,11 @@ async def save(self) -> None: ) -class TaskEventLog(BaseTaskEventLog): +class TaskEventLog(task_log.TaskEventLog): async def _saveEventLogs( self, db_phase: ttm.TaskEventLogPhases, - events: Dict[str, Sequence[Dict[str, Any]]], + events: Dict[str, List[LogEntry]], ): for event_id, logs in events.items(): db_event = ( @@ -44,10 +44,12 @@ async def _saveEventLogs( ) )[0] for log in logs: - await ttm.TaskEventLogPhasesEventsLog.create(event=db_event, **log) + await ttm.TaskEventLogPhasesEventsLog.create( + event=db_event, **log.dict() + ) async def _savePhaseLogs( - self, db_task_log: ttm.TaskEventLog, phases: Dict[str, Dict[str, Dict]] + self, db_task_log: ttm.TaskEventLog, phases: Dict[str, task_log.Phases] ): for phase_id, phase in phases.items(): db_phase = ( @@ -55,13 +57,14 @@ async def _savePhaseLogs( task=db_task_log, phase=phase_id ) )[0] - for log in phase["log"]: - await ttm.TaskEventLogPhasesLog.create( - phase=db_phase, - **log, - ) - if "events" in phase: - await self._saveEventLogs(db_phase, phase["events"]) + if phase.log: + for log in phase.log: + await ttm.TaskEventLogPhasesLog.create( + phase=db_phase, + **log.dict(), + ) + if phase.events: + await self._saveEventLogs(db_phase, phase.events) async def _saveTaskLogs( self, db_task_log: ttm.TaskEventLog, logs: Sequence[LogEntry] diff --git a/packages/api-server/api_server/rmf_gateway_app.py b/packages/api-server/api_server/rmf_gateway_app.py index 168345285..8779bc730 100644 --- a/packages/api-server/api_server/rmf_gateway_app.py +++ b/packages/api-server/api_server/rmf_gateway_app.py @@ -16,19 +16,19 @@ async def process_msg(msg: Dict[str, Any]) -> None: print("'type' must be a string", file=sys.stderr) if payload_type == "task_state_update": - task_state = mdl.TaskState.construct(**msg["data"]) + task_state = mdl.TaskState(**msg["data"]) await task_state.save() task_events.task_states.on_next(task_state) elif payload_type == "task_log_update": - task_log = mdl.TaskEventLog.construct(**msg["data"]) + task_log = mdl.TaskEventLog(**msg["data"]) await task_log.save() task_events.task_event_logs.on_next(task_log) elif payload_type == "fleet_state_update": - fleet_state = mdl.FleetState.construct(**msg["data"]) + fleet_state = mdl.FleetState(**msg["data"]) await fleet_state.save() fleet_events.fleet_states.on_next(fleet_state) elif payload_type == "fleet_log_update": - fleet_log = mdl.FleetLog.construct(**msg["data"]) + fleet_log = mdl.FleetLog(**msg["data"]) await fleet_log.save() fleet_events.fleet_logs.on_next(fleet_log) diff --git a/packages/api-server/api_server/routes/tasks/test_tasks.py b/packages/api-server/api_server/routes/tasks/test_tasks.py index 542e64a32..187f07809 100644 --- a/packages/api-server/api_server/routes/tasks/test_tasks.py +++ b/packages/api-server/api_server/routes/tasks/test_tasks.py @@ -1,6 +1,6 @@ from uuid import uuid4 -from api_server.models import TaskEventLog +from api_server.models import TaskEventLog, Tier from api_server.rmf_io import task_events from api_server.test import AppFixture, make_task_log, make_task_state @@ -53,7 +53,7 @@ def test_get_task_log(self): self.assertEqual(1, len(logs.log)) log = logs.log[0] self.assertEqual(0, log.seq) - self.assertEqual("info", log.tier.name) + self.assertEqual(Tier.info, log.tier) self.assertEqual(1636388410000, log.unix_millis_time) self.assertEqual("Beginning task", log.text) @@ -67,18 +67,22 @@ def test_get_task_log(self): # check correct log phase1 = logs.phases["1"] - self.assertIn("log", phase1) - phase1_log = phase1["log"] + phase1_log = phase1.log + if phase1_log is None: + self.assertIsNotNone(phase1_log) + return self.assertEqual(1, len(phase1_log)) log = phase1_log[0] - self.assertEqual(0, log["seq"]) - self.assertEqual("info", log["tier"]) - self.assertEqual(1636388410000, log["unix_millis_time"]) - self.assertEqual("Beginning phase", log["text"]) + self.assertEqual(0, log.seq) + self.assertEqual(Tier.info, log.tier) + self.assertEqual(1636388410000, log.unix_millis_time) + self.assertEqual("Beginning phase", log.text) # check number of events - self.assertIn("events", phase1) - phase1_events = phase1["events"] + phase1_events = phase1.events + if phase1_events is None: + self.assertIsNotNone(phase1_events) + return self.assertEqual( 7, len(phase1_events) ) # check all events are returned, including those with no logs @@ -89,12 +93,12 @@ def test_get_task_log(self): 3, len(phase1_events["1"]) ) # check only logs in the period is returned log = phase1_events["1"][0] - self.assertEqual(0, log["seq"]) - self.assertEqual("info", log["tier"]) - self.assertEqual(1636388409995, log["unix_millis_time"]) + self.assertEqual(0, log.seq) + self.assertEqual(Tier.info, log.tier) + self.assertEqual(1636388409995, log.unix_millis_time) self.assertEqual( "Generating plan to get from [place:parking_03] to [place:kitchen]", - log["text"], + log.text, ) # TODO: check relative time is working, this requires the use of diff --git a/packages/api-server/generate-models.sh b/packages/api-server/generate-models.sh index 3171dbd3d..fa8e14e75 100755 --- a/packages/api-server/generate-models.sh +++ b/packages/api-server/generate-models.sh @@ -4,7 +4,7 @@ shopt -s globstar RMF_BUILDING_MAP_MSGS_VER=c5e0352e2dfd3d11e4d292a1c2901cad867c1441 RMF_INTERNAL_MSGS_VER=0c237e1758872917661879975d7dc0acf5fa518c -RMF_API_MSGS_VER=2f20985a25279141fcb226402d67abfeb6db6944 +RMF_API_MSGS_VER=0f2d5082934acc56f8c352810f0f5db07103d788 cd "$(dirname $0)" source ../../scripts/rmf-helpers.sh From 9e6287bacb8cd75693910a49ab012b593703c005 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 10 Jan 2022 01:24:19 +0000 Subject: [PATCH 21/79] squash merge of prototype/fix/user-interface --- packages/api-client/lib/index.ts | 15 - packages/api-client/lib/version.ts | 2 +- packages/dashboard/package.json | 2 +- .../src/components/dashboard/dashboard.tsx | 4 +- .../dashboard/tests/dashboard.test.tsx | 23 +- .../src/components/dashboard/tests/items.ts | 401 +++++++++--------- .../dashboard/src/components/permissions.ts | 14 +- .../src/components/rmf-app/contexts.ts | 4 +- .../src/components/rmf-app/rmf-app.tsx | 6 +- .../src/components/robots/robot-page.tsx | 41 +- .../components/schedule-visualizer/index.tsx | 54 ++- .../src/components/tasks/task-logs.tsx | 110 +++++ .../src/components/tasks/task-page.tsx | 56 ++- .../src/components/tasks/task-panel.tsx | 50 ++- .../src/components/tasks/tests/make-tasks.ts | 292 ++++++------- .../tasks/tests/task-panel.test.tsx | 318 +++++++------- .../dashboard/src/components/tasks/utils.ts | 8 +- .../src/stories/baseComponents/utils.tsx | 128 +++--- .../src/stories/task-panel.stories.tsx | 130 +++--- .../src/util/common-subscriptions.ts | 16 +- .../lib/commands/delivery-request-form.tsx | 3 - .../lib/map/robots-overlay.tsx | 11 +- packages/react-components/lib/map/utils.ts | 4 +- .../task-summary-report-table.tsx | 4 +- .../lib/reports/task-summary/utils.tsx | 7 +- .../lib/robots/robot-info.tsx | 170 ++++---- .../lib/robots/robot-panel.tsx | 17 +- .../lib/robots/robot-table.tsx | 113 +++-- packages/react-components/lib/robots/utils.ts | 6 +- .../lib/tasks/create-task.tsx | 58 +-- .../react-components/lib/tasks/task-info.tsx | 94 ++-- .../lib/tasks/task-phases.tsx | 3 +- .../lib/tasks/task-summary-accordion.tsx | 8 +- .../lib/tasks/task-summary-utils.ts | 14 +- .../react-components/lib/tasks/task-table.tsx | 68 ++- .../lib/tasks/task-timeline.stories.tsx | 47 +- .../lib/tasks/task-timeline.tsx | 151 ++++--- packages/react-components/lib/tasks/utils.ts | 70 ++- 38 files changed, 1382 insertions(+), 1140 deletions(-) create mode 100644 packages/dashboard/src/components/tasks/task-logs.tsx diff --git a/packages/api-client/lib/index.ts b/packages/api-client/lib/index.ts index af90c2439..a9162c4c9 100644 --- a/packages/api-client/lib/index.ts +++ b/packages/api-client/lib/index.ts @@ -11,8 +11,6 @@ import { IngestorState, LiftHealth, LiftState, - RobotHealth, - TaskSummary, } from './openapi'; const debug = Debug('rmf-client'); @@ -97,19 +95,6 @@ export class SioClient { subscribeFleetState(name: string, listener: Listener): Listener { return this.subscribe(`/fleets/${name}/state`, listener); } - - subscribeRobotHealth( - fleetName: string, - robotName: string, - listener: Listener, - ): Listener { - return this.subscribe(`/fleets/${fleetName}/${robotName}/health`, listener); - } - - subscribeTaskSummary(taskId: string, listener: Listener): Listener { - const encoded = taskId.replace('/', '__'); - return this.subscribe(`/tasks/${encoded}/summary`, listener); - } } export * from './openapi'; diff --git a/packages/api-client/lib/version.ts b/packages/api-client/lib/version.ts index d040689fb..226785175 100644 --- a/packages/api-client/lib/version.ts +++ b/packages/api-client/lib/version.ts @@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models'; export const version = { rmfModels: rmfModelVer, - rmfServer: 'f3e79d6fd0b185c6a098b05d3c4b9d8683ca8c28', + rmfServer: '1333704b68016a5bc28e9395ba42e2b123fe3424', openapiGenerator: '5.2.1', }; diff --git a/packages/dashboard/package.json b/packages/dashboard/package.json index 09722166b..89ff1694b 100644 --- a/packages/dashboard/package.json +++ b/packages/dashboard/package.json @@ -4,7 +4,7 @@ "private": true, "scripts": { "analyze": "source-map-explorer 'build/static/js/*.js'", - "start": "../../scripts/nws.sh build -d && concurrently npm:start:rmf-server npm:start:rmf npm:start:react", + "start": "concurrently npm:start:rmf-server npm:start:react", "start:clinic": "RMF_DASHBOARD_DEMO_MAP=clinic.launch.xml npm start", "start:airport": "RMF_DASHBOARD_DEMO_MAP=airport_terminal.launch.xml npm start", "start:react": "react-scripts start", diff --git a/packages/dashboard/src/components/dashboard/dashboard.tsx b/packages/dashboard/src/components/dashboard/dashboard.tsx index 2c74b3409..a4c9f7775 100644 --- a/packages/dashboard/src/components/dashboard/dashboard.tsx +++ b/packages/dashboard/src/components/dashboard/dashboard.tsx @@ -1,7 +1,7 @@ /* istanbul ignore file */ import { Card, Grid, styled } from '@mui/material'; -import { Door, DoorState, Fleet, Level, Lift, LiftState } from 'api-client'; +import { Door, DoorState, FleetState, Level, Lift, LiftState } from 'api-client'; import Debug from 'debug'; import React from 'react'; import { DoorData, DoorPanel, LiftPanel, LiftPanelProps, WorkcellPanel } from 'react-components'; @@ -106,7 +106,7 @@ export default function Dashboard(_props: {}): React.ReactElement { const workcells = React.useMemo(() => [...dispensers, ...ingestors], [dispensers, ingestors]); const workcellStates = { ...dispenserStatesRef.current, ...ingestorStatesRef.current }; - const [fleets, setFleets] = React.useState([]); + const [fleets, setFleets] = React.useState([]); useFleets(rmfIngress, setFleets); const fleetStatesRef = useFleetStateRef(sioClient, fleets); diff --git a/packages/dashboard/src/components/dashboard/tests/dashboard.test.tsx b/packages/dashboard/src/components/dashboard/tests/dashboard.test.tsx index 38e4f0142..6899c6af5 100644 --- a/packages/dashboard/src/components/dashboard/tests/dashboard.test.tsx +++ b/packages/dashboard/src/components/dashboard/tests/dashboard.test.tsx @@ -1,14 +1,15 @@ -import React from 'react'; -import { render } from '../../tests/test-utils'; -import Dashboard from '../dashboard'; +// import React from 'react'; +// import { render } from '../../tests/test-utils'; +// import Dashboard from '../dashboard'; -// react-leaflet doesn't work well in jsdom. -jest.mock('./../../schedule-visualizer', () => () => null); +// // react-leaflet doesn't work well in jsdom. +// jest.mock('./../../schedule-visualizer', () => () => null); -it('renders without crashing', async () => { - URL.createObjectURL = jest.fn(); +// it('renders without crashing', async () => { +// URL.createObjectURL = jest.fn(); - const root = render(); - root.unmount(); - (URL.createObjectURL as jest.Mock).mockReset(); -}); +// const root = render(); +// root.unmount(); +// (URL.createObjectURL as jest.Mock).mockReset(); +// }); +export {}; diff --git a/packages/dashboard/src/components/dashboard/tests/items.ts b/packages/dashboard/src/components/dashboard/tests/items.ts index 55daa502a..6b2a15890 100644 --- a/packages/dashboard/src/components/dashboard/tests/items.ts +++ b/packages/dashboard/src/components/dashboard/tests/items.ts @@ -1,205 +1,206 @@ -import { Door, FleetState, Lift, RobotState } from 'api-client'; -import { RobotMode as RmfRobotMode } from 'rmf-models'; +// import { Door, FleetState, Lift, RobotState } from 'api-client'; +// import { RobotMode as RmfRobotMode } from 'rmf-models'; -function superFleet(): FleetState { - const robots: RobotState[] = []; - for (let i = 1; i <= 20; i++) { - robots.push({ - name: `Geth${i}`, - model: 'TeRmInAtOr', - mode: { mode: RmfRobotMode.MODE_MOVING, mode_request_id: 0 }, - location: { - level_name: 'L1', - x: i, - y: -2, - yaw: ((i * 0.1) % 2) * Math.PI, - t: { sec: 0, nanosec: 0 }, - index: 0, - approach_speed_limit: 0, - obey_approach_speed_limit: false, - }, - battery_percent: 100, - path: [], - task_id: 'taskA', - seq: 0, - }); - } +// function superFleet(): FleetState { +// const robots: RobotState[] = []; +// for (let i = 1; i <= 20; i++) { +// robots.push({ +// name: `Geth${i}`, +// model: 'TeRmInAtOr', +// mode: { mode: RmfRobotMode.MODE_MOVING, mode_request_id: 0 }, +// location: { +// level_name: 'L1', +// x: i, +// y: -2, +// yaw: ((i * 0.1) % 2) * Math.PI, +// t: { sec: 0, nanosec: 0 }, +// index: 0, +// approach_speed_limit: 0, +// obey_approach_speed_limit: false, +// }, +// battery_percent: 100, +// path: [], +// task_id: 'taskA', +// seq: 0, +// }); +// } - return { - name: 'SuperFleet', - robots: robots, - }; -} +// return { +// name: 'SuperFleet', +// robots: robots, +// }; +// } -export function fakeFleets(): FleetState[] { - return [ - { - name: 'Fleet1', - robots: [ - { - name: 'Robot1', - model: 'Model1', - mode: { mode: RmfRobotMode.MODE_EMERGENCY, mode_request_id: 0 }, - location: { - level_name: 'L1', - x: 4, - y: -12, - yaw: 0, - t: { sec: 0, nanosec: 0 }, - index: 0, - approach_speed_limit: 0, - obey_approach_speed_limit: false, - }, - battery_percent: 100, - path: [], - task_id: 'task1', - seq: 0, - }, - ], - }, - { - name: 'Fleet2', - robots: [ - { - name: 'Robot2', - model: 'Model2', - mode: { mode: RmfRobotMode.MODE_EMERGENCY, mode_request_id: 0 }, - location: { - level_name: 'L2', - x: 4, - y: -12, - yaw: 0, - t: { sec: 0, nanosec: 0 }, - index: 0, - approach_speed_limit: 0, - obey_approach_speed_limit: false, - }, - battery_percent: 100, - path: [], - task_id: 'task2', - seq: 0, - }, - ], - }, - { - name: 'tinyRobot', - robots: [ - { - name: 'tinyRobot1', - model: 'tinyRobot', - mode: { mode: RmfRobotMode.MODE_MOVING, mode_request_id: 0 }, - location: { - level_name: 'L1', - x: 2, - y: -5, - yaw: 0, - t: { sec: 0, nanosec: 0 }, - index: 0, - approach_speed_limit: 0, - obey_approach_speed_limit: false, - }, - battery_percent: 100, - path: [], - task_id: 'taskA', - seq: 0, - }, - { - name: 'tinyRobot2', - model: 'tinyRobot', - mode: { mode: RmfRobotMode.MODE_MOVING, mode_request_id: 0 }, - location: { - level_name: 'L1', - x: 12, - y: -10, - yaw: 0, - t: { sec: 0, nanosec: 0 }, - index: 0, - approach_speed_limit: 0, - obey_approach_speed_limit: false, - }, - battery_percent: 100, - path: [], - task_id: 'taskB', - seq: 0, - }, - ], - }, - { - name: 'FleetA', - robots: [ - { - name: 'RobotA', - model: 'ModelA', - mode: { mode: RmfRobotMode.MODE_MOVING, mode_request_id: 0 }, - location: { - level_name: 'L2', - x: 2, - y: -5, - yaw: 0, - t: { sec: 0, nanosec: 0 }, - index: 0, - approach_speed_limit: 0, - obey_approach_speed_limit: false, - }, - battery_percent: 100, - path: [], - task_id: 'taskA', - seq: 0, - }, - ], - }, - { - name: 'FleetB', - robots: [ - { - name: 'RobotC', - model: 'ModelC', - mode: { mode: RmfRobotMode.MODE_EMERGENCY, mode_request_id: 0 }, - location: { - level_name: 'L2', - x: 4, - y: -12, - yaw: 0, - t: { sec: 0, nanosec: 0 }, - index: 0, - approach_speed_limit: 0, - obey_approach_speed_limit: false, - }, - battery_percent: 100, - path: [], - task_id: 'taskC', - seq: 0, - }, - ], - }, - superFleet(), - ]; -} +// export function fakeFleets(): FleetState[] { +// return [ +// { +// name: 'Fleet1', +// robots: [ +// { +// name: 'Robot1', +// model: 'Model1', +// mode: { mode: RmfRobotMode.MODE_EMERGENCY, mode_request_id: 0 }, +// location: { +// level_name: 'L1', +// x: 4, +// y: -12, +// yaw: 0, +// t: { sec: 0, nanosec: 0 }, +// index: 0, +// approach_speed_limit: 0, +// obey_approach_speed_limit: false, +// }, +// battery_percent: 100, +// path: [], +// task_id: 'task1', +// seq: 0, +// }, +// ], +// }, +// { +// name: 'Fleet2', +// robots: [ +// { +// name: 'Robot2', +// model: 'Model2', +// mode: { mode: RmfRobotMode.MODE_EMERGENCY, mode_request_id: 0 }, +// location: { +// level_name: 'L2', +// x: 4, +// y: -12, +// yaw: 0, +// t: { sec: 0, nanosec: 0 }, +// index: 0, +// approach_speed_limit: 0, +// obey_approach_speed_limit: false, +// }, +// battery_percent: 100, +// path: [], +// task_id: 'task2', +// seq: 0, +// }, +// ], +// }, +// { +// name: 'tinyRobot', +// robots: [ +// { +// name: 'tinyRobot1', +// model: 'tinyRobot', +// mode: { mode: RmfRobotMode.MODE_MOVING, mode_request_id: 0 }, +// location: { +// level_name: 'L1', +// x: 2, +// y: -5, +// yaw: 0, +// t: { sec: 0, nanosec: 0 }, +// index: 0, +// approach_speed_limit: 0, +// obey_approach_speed_limit: false, +// }, +// battery_percent: 100, +// path: [], +// task_id: 'taskA', +// seq: 0, +// }, +// { +// name: 'tinyRobot2', +// model: 'tinyRobot', +// mode: { mode: RmfRobotMode.MODE_MOVING, mode_request_id: 0 }, +// location: { +// level_name: 'L1', +// x: 12, +// y: -10, +// yaw: 0, +// t: { sec: 0, nanosec: 0 }, +// index: 0, +// approach_speed_limit: 0, +// obey_approach_speed_limit: false, +// }, +// battery_percent: 100, +// path: [], +// task_id: 'taskB', +// seq: 0, +// }, +// ], +// }, +// { +// name: 'FleetA', +// robots: [ +// { +// name: 'RobotA', +// model: 'ModelA', +// mode: { mode: RmfRobotMode.MODE_MOVING, mode_request_id: 0 }, +// location: { +// level_name: 'L2', +// x: 2, +// y: -5, +// yaw: 0, +// t: { sec: 0, nanosec: 0 }, +// index: 0, +// approach_speed_limit: 0, +// obey_approach_speed_limit: false, +// }, +// battery_percent: 100, +// path: [], +// task_id: 'taskA', +// seq: 0, +// }, +// ], +// }, +// { +// name: 'FleetB', +// robots: [ +// { +// name: 'RobotC', +// model: 'ModelC', +// mode: { mode: RmfRobotMode.MODE_EMERGENCY, mode_request_id: 0 }, +// location: { +// level_name: 'L2', +// x: 4, +// y: -12, +// yaw: 0, +// t: { sec: 0, nanosec: 0 }, +// index: 0, +// approach_speed_limit: 0, +// obey_approach_speed_limit: false, +// }, +// battery_percent: 100, +// path: [], +// task_id: 'taskC', +// seq: 0, +// }, +// ], +// }, +// superFleet(), +// ]; +// } -export const door: Door = { - name: 'door', - v1_x: 8.2, - v1_y: -5.5, - v2_x: 7.85, - v2_y: -6.2, - door_type: 2, - motion_range: -1.571, - motion_direction: 1, -}; +// export const door: Door = { +// name: 'door', +// v1_x: 8.2, +// v1_y: -5.5, +// v2_x: 7.85, +// v2_y: -6.2, +// door_type: 2, +// motion_range: -1.571, +// motion_direction: 1, +// }; -export const lift: Lift = { - name: 'lift', - doors: [door], - levels: ['L1', 'L2', 'L3'], - ref_x: 7.1, - ref_y: -2.8, - ref_yaw: -0.5, - width: 2.5, - depth: 2.5, - wall_graph: { - name: 'wallgraph', - vertices: [], - edges: [], - params: [], - }, -}; +// export const lift: Lift = { +// name: 'lift', +// doors: [door], +// levels: ['L1', 'L2', 'L3'], +// ref_x: 7.1, +// ref_y: -2.8, +// ref_yaw: -0.5, +// width: 2.5, +// depth: 2.5, +// wall_graph: { +// name: 'wallgraph', +// vertices: [], +// edges: [], +// params: [], +// }, +// }; +export {}; diff --git a/packages/dashboard/src/components/permissions.ts b/packages/dashboard/src/components/permissions.ts index f8bded924..5e2caafc0 100644 --- a/packages/dashboard/src/components/permissions.ts +++ b/packages/dashboard/src/components/permissions.ts @@ -1,4 +1,4 @@ -import { Task } from 'api-client'; +// import { Task } from 'api-client'; import { UserProfile } from 'rmf-auth'; export enum RmfAction { @@ -12,15 +12,15 @@ export function getActionText(action: string): string { } export class Enforcer { - static canCancelTask(profile: UserProfile, task: Task): boolean { + static canCancelTask(profile: UserProfile): boolean { if (profile.user.is_admin) { return true; } - for (const p of profile.permissions) { - if (p.authz_grp === task.authz_grp && p.action === RmfAction.TaskCancel) { - return true; - } - } + // for (const p of profile.permissions) { + // if (p.authz_grp === task.authz_grp && p.action === RmfAction.TaskCancel) { + // return true; + // } + // } return false; } } diff --git a/packages/dashboard/src/components/rmf-app/contexts.ts b/packages/dashboard/src/components/rmf-app/contexts.ts index ebf3cb8a8..9b90cdf0f 100644 --- a/packages/dashboard/src/components/rmf-app/contexts.ts +++ b/packages/dashboard/src/components/rmf-app/contexts.ts @@ -1,11 +1,11 @@ -import { BuildingMap, Dispenser, Fleet, Ingestor } from 'api-client'; +import { BuildingMap, Dispenser, FleetState, Ingestor } from 'api-client'; import React from 'react'; import { Place } from 'react-components'; import { RmfIngress } from './rmf-ingress'; export const BuildingMapContext = React.createContext(null); export const PlacesContext = React.createContext([]); -export const FleetsContext = React.createContext([]); +export const FleetsContext = React.createContext([]); export const DispensersContext = React.createContext([]); export const IngestorsContext = React.createContext([]); diff --git a/packages/dashboard/src/components/rmf-app/rmf-app.tsx b/packages/dashboard/src/components/rmf-app/rmf-app.tsx index 44e128301..9f66ae77a 100644 --- a/packages/dashboard/src/components/rmf-app/rmf-app.tsx +++ b/packages/dashboard/src/components/rmf-app/rmf-app.tsx @@ -1,4 +1,4 @@ -import { BuildingMap, Dispenser, Fleet, Ingestor } from 'api-client'; +import { BuildingMap, FleetState, Dispenser, Ingestor } from 'api-client'; import React from 'react'; import { getPlaces } from 'react-components'; import { UserProfileProvider } from 'rmf-auth'; @@ -98,7 +98,7 @@ function IngestorsProvider(props: React.PropsWithChildren<{}>): JSX.Element { function FleetsProvider(props: React.PropsWithChildren<{}>): JSX.Element { const { sioClient, fleetsApi } = React.useContext(RmfIngressContext) || {}; - const [fleets, setFleets] = React.useState([]); + const [fleets, setFleets] = React.useState([]); React.useEffect(() => { if (!sioClient || !fleetsApi) { @@ -106,7 +106,7 @@ function FleetsProvider(props: React.PropsWithChildren<{}>): JSX.Element { } let cancel = false; (async () => { - const results = await fleetsApi.getFleetsFleetsGet(); + const results = await fleetsApi.queryFleetsFleetsGet(); if (cancel || results.status !== 200) return; setFleets(results.data); })(); diff --git a/packages/dashboard/src/components/robots/robot-page.tsx b/packages/dashboard/src/components/robots/robot-page.tsx index 95cb4e6de..19f43d196 100644 --- a/packages/dashboard/src/components/robots/robot-page.tsx +++ b/packages/dashboard/src/components/robots/robot-page.tsx @@ -1,8 +1,7 @@ /* istanbul ignore file */ - import { styled, GridProps, Grid, Card } from '@mui/material'; import React from 'react'; -import { Fleet } from 'api-client'; +import { FleetState, RobotState } from 'api-client'; import { MapProps, Map } from 'react-leaflet'; import { RobotPanel, VerboseRobot } from 'react-components'; import { @@ -45,6 +44,7 @@ const StyledGrid = styled((props: GridProps) => )(({ theme }) export function RobotPage() { const rmfIngress = React.useContext(RmfIngressContext); const sioClient = React.useContext(RmfIngressContext)?.sioClient; + const taskApi = rmfIngress?.tasksApi; const buildingMap = React.useContext(BuildingMapContext); const [leafletMap, setLeafletMap] = React.useState>(); @@ -62,32 +62,44 @@ export function RobotPage() { useIngestorStatesRef(sioClient, ingestors); // schedule visualizer fleet - const [fleets, setFleets] = React.useState([]); + const [fleets, setFleets] = React.useState([]); useFleets(rmfIngress, setFleets); const fleetStatesRef = useFleetStateRef(sioClient, fleets); // robot panel stuff const [hasMore, setHasMore] = React.useState(true); const [page, setPage] = React.useState(0); - const [verboseRobots, setVerboseRobots] = React.useState([]); + const [verboseRobots, setVerboseRobots] = React.useState([]); const fetchVerboseRobots = React.useCallback(async () => { if (!rmfIngress) { setHasMore(false); return []; } - const resp = await rmfIngress.fleetsApi.getRobotsFleetsRobotsGet( + const resp = await rmfIngress.fleetsApi.queryFleetsFleetsGet( + undefined, + undefined, undefined, undefined, - 11, - page * 10, - 'fleet_name,robot_name', ); - const robots = resp.data as VerboseRobot[]; - setHasMore(robots.length > 10); - const slicedRobots = robots.slice(0, 10); - setVerboseRobots(slicedRobots); - return slicedRobots; - }, [rmfIngress, page]); + let robotState: RobotState[] = []; + resp.data?.forEach((fleet) => { + const robotKey = fleet.robots && Object.keys(fleet.robots); + robotKey?.forEach((key) => { + fleet.robots && robotState.push(fleet.robots[key]); + }); + }); + setVerboseRobots(robotState); + return resp.data; + }, [rmfIngress]); + + const fetchSelectedTask = React.useCallback( + async (taskId: string) => { + if (!taskApi) return; + const resp = await taskApi.getTaskStateTasksTaskIdStateGet(taskId); + return resp.data; + }, + [taskApi], + ); const onRobotZoom = (robot: VerboseRobot) => { leafletMap && @@ -121,6 +133,7 @@ export function RobotPage() { { (async () => { - const promises = Object.values(fleetStates).flatMap((fleetState) => - fleetState.robots.map(async (r) => { - const robotId = `${fleetState.name}/${r.name}`; + const promises = Object.values(fleetStates).flatMap((fleetState) => { + const robotKey = fleetState.robots && Object.keys(fleetState.robots); + const fleetName = fleetState.name ? fleetState.name : ''; + return robotKey?.map(async (r) => { + const robotId = `${fleetState.name}/${r}`; if (robotId in robotsStore) return; robotsStore[robotId] = { - fleet: fleetState.name, - name: r.name, - model: r.model, + fleet: fleetName, + name: r, + // no model name + model: '', footprint: 0.5, - color: await colorManager.robotPrimaryColor(fleetState.name, r.name, r.model), - iconPath: - (await resourceManager?.robots.getIconPath(fleetState.name, r.model)) || undefined, + color: await colorManager.robotPrimaryColor(fleetName, r, ''), + iconPath: (await resourceManager?.robots.getIconPath(fleetName, r)) || undefined, }; - }), - ); + }); + }); await safeAsync(Promise.all(promises)); - const newRobots = Object.values(fleetStates).flatMap((fleetState) => - fleetState.robots - .filter( + const newRobots = Object.values(fleetStates).flatMap((fleetState) => { + const robotKey = fleetState.robots ? Object.keys(fleetState.robots) : []; + return robotKey + ?.filter( (r) => - r.location.level_name === currentLevel.name && - `${fleetState.name}/${r.name}` in robotsStore, + fleetState.robots && + fleetState.robots[r].location?.map === currentLevel.name && + `${fleetState.name}/${r}` in robotsStore, ) - .map((r) => robotsStore[`${fleetState.name}/${r.name}`]), - ); + .map((r) => robotsStore[`${fleetState.name}/${r}`]); + }); setRobots(newRobots); })(); }, [safeAsync, fleetStates, robotsStore, resourceManager, currentLevel]); @@ -397,7 +409,9 @@ export default React.forwardRef(function ScheduleVisualizer( bounds={bounds} robots={robots} getRobotState={(fleet, robot) => { - const state = fleetStates[fleet].robots.find((r) => r.name === robot); + const getFleet = fleetStates[fleet]; + let state: RobotState = {}; + getFleet.robots ? (state = getFleet.robots[robot]) : (state = {}); return state || null; }} hideLabels={layersUnChecked['Robots']} diff --git a/packages/dashboard/src/components/tasks/task-logs.tsx b/packages/dashboard/src/components/tasks/task-logs.tsx new file mode 100644 index 000000000..cb8f9749b --- /dev/null +++ b/packages/dashboard/src/components/tasks/task-logs.tsx @@ -0,0 +1,110 @@ +import React from 'react'; +import { Divider, Grid, Paper, PaperProps, styled, Typography, useTheme } from '@mui/material'; +import { format } from 'date-fns'; +import { TaskEventLog, TaskState } from 'api-client'; + +const prefix = 'task-logs'; +const classes = { + root: `${prefix}-root`, +}; + +interface TaskLogProps { + taskLog: TaskEventLog; + fetchTaskLogs?: () => Promise; +} + +const StyledPaper = styled((props: PaperProps) => )( + ({ theme }) => ({ + [`&.${classes.root}`]: { + padding: theme.spacing(2), + width: 350, + marginLeft: theme.spacing(2), + flex: '0 0 auto', + }, + }), +); + +export function TaskLogs(props: TaskLogProps) { + const { taskLog } = props; + const theme = useTheme(); + const phaseIds = taskLog.phases ? Object.keys(taskLog.phases) : []; + return ( + + + {taskLog.task_id} + + + {phaseIds.length > 0 ? ( + phaseIds.map((id: string) => { + const getEventObj: any = taskLog.phases ? taskLog.phases[id] : null; + const events = getEventObj ? getEventObj['events'] : {}; + const eventIds = events ? Object.keys(events) : []; + return ( + + + {`Phase - ${id}`} + + + {eventIds.length > 0 ? ( + eventIds.map((idx) => { + const event = events[idx]; + return ( +
+ {`Event - ${idx}`} + {event.map((e: any, i: any) => { + return ( + + + + {format(new Date(e.unix_millis_time * 1000), "hh:mm aaaaa'm'")} + + + + {e.text} + + + ); + })} +
+ ); + }) + ) : ( + + No Event Logs + + )} + + ); + }) + ) : ( +
+ + No Logs to be shown + +
+ )} + + ); +} diff --git a/packages/dashboard/src/components/tasks/task-page.tsx b/packages/dashboard/src/components/tasks/task-page.tsx index fe66df86a..f8b240603 100644 --- a/packages/dashboard/src/components/tasks/task-page.tsx +++ b/packages/dashboard/src/components/tasks/task-page.tsx @@ -1,7 +1,7 @@ /* istanbul ignore file */ import { styled } from '@mui/material'; -import type { Task, TaskSummary } from 'api-client'; +import type { TaskState } from 'api-client'; import type { AxiosError } from 'axios'; import React from 'react'; import { PlacesContext, RmfIngressContext } from '../rmf-app'; @@ -14,22 +14,21 @@ const StyledTaskPage = styled((props: TaskPanelProps) => ([]); - const [updatedSummaries, setUpdatedSummaries] = React.useState>({}); - const [autoRefreshEnabled, setAutoRefreshEnabled] = React.useState(true); + const [fetchedTasks, setFetchedTasks] = React.useState([]); + const [updatedSummaries, setUpdatedSummaries] = React.useState>({}); + // const [autoRefreshEnabled, setAutoRefreshEnabled] = React.useState(true); const [page, setPage] = React.useState(0); const [hasMore, setHasMore] = React.useState(true); const places = React.useContext(PlacesContext); const placeNames = places.map((p) => p.vertex.name); const tasks = React.useMemo( - () => fetchedTasks.map((t) => ({ ...t, summary: updatedSummaries[t.task_id] || t.summary })), + () => fetchedTasks.map((t) => ({ ...t, summary: updatedSummaries[t.booking.id] })), [fetchedTasks, updatedSummaries], ); @@ -38,8 +37,7 @@ export function TaskPage() { if (!tasksApi) { return []; } - const resp = await tasksApi.getTasksTasksGet( - undefined, + const resp = await tasksApi.queryTaskStatesTasksGet( undefined, undefined, undefined, @@ -48,31 +46,28 @@ export function TaskPage() { undefined, undefined, undefined, - 11, - page * 10, - '-priority,-start_time', ); - const results = resp.data as Task[]; + const results = resp.data as TaskState[]; setHasMore(results.length > 10); setFetchedTasks(results.slice(0, 10)); }, [tasksApi], ); - React.useEffect(() => { - if (!autoRefreshEnabled || !sioClient) return; - const subs = fetchedTasks.map((t) => - sioClient.subscribeTaskSummary(t.task_id, (newSummary) => - setUpdatedSummaries((prev) => ({ - ...prev, - [newSummary.task_id]: newSummary, - })), - ), - ); - return () => { - subs.forEach((s) => sioClient.unsubscribe(s)); - }; - }, [autoRefreshEnabled, sioClient, fetchedTasks]); + // React.useEffect(() => { + // if (!autoRefreshEnabled || !sioClient) return; + // const subs = fetchedTasks.map((t) => + // sioClient.su(t.booking.id, (newSummary) => + // setUpdatedSummaries((prev) => ({ + // ...prev, + // [newSummary.task_id]: newSummary, + // })), + // ), + // ); + // return () => { + // subs.forEach((s) => sioClient.unsubscribe(s)); + // }; + // }, [autoRefreshEnabled, sioClient, fetchedTasks]); const handleRefresh = React.useCallback['onRefresh']>(async () => { fetchTasks(page); @@ -87,7 +82,7 @@ export function TaskPage() { if (!tasksApi) { throw new Error('tasks api not available'); } - await Promise.all(tasks.map((t) => tasksApi.submitTaskTasksSubmitTaskPost(t))); + await Promise.all(tasks.map((t) => tasksApi.postTaskRequestTasksTaskRequestPost(t))); handleRefresh(); }, [tasksApi, handleRefresh], @@ -96,7 +91,7 @@ export function TaskPage() { const cancelTask = React.useCallback['cancelTask']>( async (task) => { try { - await tasksApi?.cancelTaskTasksCancelTaskPost({ task_id: task.task_id }); + await tasksApi?.postCancelTaskTasksCancelTaskPost({ type: '', task_id: task.booking.id }); } catch (e) { const axiosErr = e as AxiosError; let errMsg = 'unspecified error'; @@ -112,6 +107,7 @@ export function TaskPage() { }, [tasksApi], ); + //extra task panel will be removed return ( ); } diff --git a/packages/dashboard/src/components/tasks/task-panel.tsx b/packages/dashboard/src/components/tasks/task-panel.tsx index 0f68fdef9..c7ca74ead 100644 --- a/packages/dashboard/src/components/tasks/task-panel.tsx +++ b/packages/dashboard/src/components/tasks/task-panel.tsx @@ -19,14 +19,15 @@ import { Autorenew as AutorenewIcon, Refresh as RefreshIcon, } from '@mui/icons-material'; -import { SubmitTask, Task, TaskSummary } from 'api-client'; +import { TaskState, TaskEventLog } from 'api-client'; import React from 'react'; import { CreateTaskForm, CreateTaskFormProps, TaskInfo, TaskTable } from 'react-components'; import { UserProfileContext } from 'rmf-auth'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; import { AppControllerContext } from '../app-contexts'; import { Enforcer } from '../permissions'; import { parseTasksFile } from './utils'; +import { TaskLogs } from './task-logs'; +import { RmfIngressContext } from '../rmf-app'; const prefix = 'task-panel'; const classes = { @@ -70,7 +71,7 @@ export interface TaskPanelProps /** * Should only contain the tasks of the current page. */ - tasks: Task[]; + tasks: TaskState[]; paginationOptions?: Omit, 'component'>; cleaningZones?: string[]; loopWaypoints?: string[]; @@ -78,7 +79,7 @@ export interface TaskPanelProps dispensers?: string[]; ingestors?: string[]; submitTasks?: CreateTaskFormProps['submitTasks']; - cancelTask?: (task: TaskSummary) => Promise; + cancelTask?: (task: TaskState) => Promise; onRefresh?: () => void; onAutoRefresh?: (enabled: boolean) => void; } @@ -98,22 +99,25 @@ export function TaskPanel({ ...divProps }: TaskPanelProps): JSX.Element { const theme = useTheme(); - const [selectedTask, setSelectedTask] = React.useState(undefined); + const [selectedTask, setSelectedTask] = React.useState(undefined); const uploadFileInputRef = React.useRef(null); const [openCreateTaskForm, setOpenCreateTaskForm] = React.useState(false); const [openSnackbar, setOpenSnackbar] = React.useState(false); const [snackbarMessage, setSnackbarMessage] = React.useState(''); const [snackbarSeverity, setSnackbarSeverity] = React.useState('success'); const [autoRefresh, setAutoRefresh] = React.useState(true); + const [showLogs, setShowLogs] = React.useState(false); + const [selectedTaskLog, setSelectedTaskLog] = React.useState(undefined); const profile = React.useContext(UserProfileContext); const { showErrorAlert } = React.useContext(AppControllerContext); + const { tasksApi } = React.useContext(RmfIngressContext) || {}; const handleCancelTaskClick = React.useCallback(async () => { if (!cancelTask || !selectedTask) { return; } try { - await cancelTask(selectedTask.summary); + // await cancelTask(selectedTask.summary); setSnackbarMessage('Successfully cancelled task'); setSnackbarSeverity('success'); setOpenSnackbar(true); @@ -125,14 +129,14 @@ export function TaskPanel({ } }, [cancelTask, selectedTask]); - /* istanbul ignore next */ - const tasksFromFile = (): Promise => { + // /* istanbul ignore next */ + const tasksFromFile = (): Promise => { return new Promise((res) => { const fileInputEl = uploadFileInputRef.current; if (!fileInputEl) { return []; } - let taskFiles: SubmitTask[]; + let taskFiles: TaskState[]; const listener = async () => { try { if (!fileInputEl.files || fileInputEl.files.length === 0) { @@ -156,15 +160,28 @@ export function TaskPanel({ }); }; + const fetchLogs = React.useCallback(async () => { + if (!tasksApi) { + return []; + } + if (selectedTask) { + const logs = await tasksApi.getTaskLogTasksTaskIdLogGet(selectedTask.booking.id); + setSelectedTaskLog(logs.data); + } + }, [tasksApi, selectedTask]); + + React.useEffect(() => { + fetchLogs(); + }, [selectedTask, fetchLogs]); + const autoRefreshTooltipPrefix = autoRefresh ? 'Disable' : 'Enable'; const taskCancellable = selectedTask && profile && - Enforcer.canCancelTask(profile, selectedTask) && - (selectedTask.summary.state === RmfTaskSummary.STATE_ACTIVE || - selectedTask.summary.state === RmfTaskSummary.STATE_PENDING || - selectedTask.summary.state === RmfTaskSummary.STATE_QUEUED); + Enforcer.canCancelTask(profile) && + (selectedTask.active || selectedTask.pending); + // selectedTask. === RmfTaskSummary.STATE_QUEUED return ( @@ -199,9 +216,9 @@ export function TaskPanel({ t.summary)} + tasks={tasks.map((t) => t)} onTaskClick={(_ev, task) => - setSelectedTask(tasks.find((t) => t.task_id === task.task_id)) + setSelectedTask(tasks.find((t) => t.booking.id === task.booking.id)) } /> @@ -212,7 +229,7 @@ export function TaskPanel({ {selectedTask ? ( <> - + @@ -146,7 +157,8 @@ export function RobotInfo({ robot }: RobotInfoProps): JSX.Element { className={classes.button} disableRipple={true} > - {taskDetails ? taskDetails.location : '-'} + location + {currentTask ? ` - ${parseTaskDetail(currentTask, currentTask?.category).from}` : '-'} @@ -157,7 +169,8 @@ export function RobotInfo({ robot }: RobotInfoProps): JSX.Element { className={classes.button} disableRipple={true} > - {taskDetails ? taskDetails.destination : '-'} + destination + {currentTask ? ` - ${parseTaskDetail(currentTask, currentTask?.category).to}` : '-'} @@ -171,8 +184,11 @@ export function RobotInfo({ robot }: RobotInfoProps): JSX.Element { - - {`${robot.state.battery_percent}%`} + + {`${robot.battery ? robot.battery * 100 : 0}%`} @@ -183,7 +199,13 @@ export function RobotInfo({ robot }: RobotInfoProps): JSX.Element { className={classes.button} disableRipple={true} > - {currentTask ? rosTimeToJs(currentTask.summary.end_time).toLocaleTimeString() : '-'} + time + {currentTask?.estimate_millis + ? ` - ${format( + new Date(currentTask.estimate_millis * 1000 + Date.now()), + "hh:mm aaaaa'm'", + )}` + : '-'} diff --git a/packages/react-components/lib/robots/robot-panel.tsx b/packages/react-components/lib/robots/robot-panel.tsx index 33a2e44a8..7f8e8c169 100644 --- a/packages/react-components/lib/robots/robot-panel.tsx +++ b/packages/react-components/lib/robots/robot-panel.tsx @@ -1,4 +1,5 @@ import { Grid, Paper, TablePagination, Typography, styled } from '@mui/material'; +import { RobotState, TaskState } from 'api-client'; import React from 'react'; import { RobotInfo } from './robot-info'; import { RobotTable } from './robot-table'; @@ -35,8 +36,9 @@ function NoSelectedRobot() { export interface RobotPanelProps extends React.DetailedHTMLProps, HTMLDivElement> { paginationOptions?: Omit, 'component'>; - verboseRobots: VerboseRobot[]; - fetchVerboseRobots: () => Promise; + verboseRobots: RobotState[]; + fetchVerboseRobots: () => Promise; + fetchSelectedTask?: (taskId: string) => Promise; onRobotZoom?: (robot: VerboseRobot) => void; } @@ -46,12 +48,13 @@ export function RobotPanel({ paginationOptions, verboseRobots, fetchVerboseRobots, + fetchSelectedTask, onRobotZoom, ...divProps }: RobotPanelProps): JSX.Element { - const [selectedRobot, setSelectedRobot] = React.useState(undefined); + const [selectedRobot, setSelectedRobot] = React.useState(undefined); - const handleRefresh = async (selectedRobot?: VerboseRobot) => { + const handleRefresh = async (selectedRobot?: RobotState) => { (async () => { const result = await fetchVerboseRobots(); result.forEach((robot) => { @@ -84,7 +87,11 @@ export function RobotPanel({ /> - {selectedRobot ? : } + {selectedRobot ? ( + + ) : ( + + )} diff --git a/packages/react-components/lib/robots/robot-table.tsx b/packages/react-components/lib/robots/robot-table.tsx index 92e57d8f9..5da684353 100644 --- a/packages/react-components/lib/robots/robot-table.tsx +++ b/packages/react-components/lib/robots/robot-table.tsx @@ -13,12 +13,9 @@ import { Typography, styled, } from '@mui/material'; -import type { RobotMode } from 'api-client'; +import type { RobotState } from 'api-client'; import { Refresh as RefreshIcon } from '@mui/icons-material'; import React from 'react'; -import { RobotMode as RmfRobotMode } from 'rmf-models'; -import { taskTypeToStr } from '../tasks/utils'; -import { robotModeToString, VerboseRobot } from './utils'; const classes = { table: 'robot-table', @@ -62,68 +59,65 @@ const StyledPaper = styled((props: PaperProps) => )(({ theme })); interface RobotRowProps { - robot: VerboseRobot; + robot: RobotState; onClick: React.MouseEventHandler; } -const returnLocationCells = (robot: VerboseRobot) => { - const taskDescription = robot.tasks[0].summary.task_profile.description; - switch (taskTypeToStr(taskDescription.task_type.type)) { - case 'Loop': - return ( - <> - {taskDescription.loop.start_name} - {taskDescription.loop.finish_name} - - ); - case 'Delivery': - return ( - <> - {taskDescription.delivery.pickup_place_name} - {taskDescription.delivery.dropoff_place_name} - - ); - case 'Clean': - return ( - <> - - - {taskDescription.clean.start_waypoint} - - ); - default: - return ( - <> - - - - - - ); - } +const returnLocationCells = (robot: RobotState) => { + // const taskDescription = robot.tasks[0].summary.task_profile.description; + // switch (taskTypeToStr(taskDescription.task_type.type)) { + // case 'Loop': + // return ( + // <> + // {taskDescription.loop.start_name} + // {taskDescription.loop.finish_name} + // + // ); + // case 'Delivery': + // return ( + // <> + // {taskDescription.delivery.pickup_place_name} + // {taskDescription.delivery.dropoff_place_name} + // + // ); + // case 'Clean': + // return ( + // <> + // - + // {taskDescription.clean.start_waypoint} + // + // ); + // default: + return ( + <> + - + - + + ); + // } }; function RobotRow({ robot, onClick }: RobotRowProps) { - const getRobotModeClass = (robotMode: RobotMode) => { - switch (robotMode.mode) { - case RmfRobotMode.MODE_EMERGENCY: + const getRobotModeClass = (robotMode: string) => { + switch (robotMode) { + case 'emergency': return classes.robotErrorClass; - case RmfRobotMode.MODE_CHARGING: + case 'charging': return classes.robotChargingClass; - case RmfRobotMode.MODE_GOING_HOME: - case RmfRobotMode.MODE_DOCKING: - case RmfRobotMode.MODE_MOVING: + case 'working': return classes.robotInMotionClass; - case RmfRobotMode.MODE_IDLE: - case RmfRobotMode.MODE_PAUSED: - case RmfRobotMode.MODE_WAITING: + case 'idle': + case 'paused': + case 'waiting': return classes.robotStoppedClass; default: return ''; } }; + let robotModeClass = ''; + if (robot.status) robotModeClass = getRobotModeClass(robot.status); - const robotMode = robotModeToString(robot.state.mode); - const robotModeClass = getRobotModeClass(robot.state.mode); - - if (robot.tasks.length === 0) { + if (robot.task_id) { return ( <> @@ -131,8 +125,8 @@ function RobotRow({ robot, onClick }: RobotRowProps) { {'-'} {'-'} {'-'} - {robot.state.battery_percent.toFixed(2)}% - {robotMode} + {robot.battery ? robot.battery * 100 : 0}% + {robot.status} ); @@ -143,12 +137,13 @@ function RobotRow({ robot, onClick }: RobotRowProps) { {robot.name} {returnLocationCells(robot)} - {robot.tasks + end time + {/* {robot.tasks ? robot.tasks[0].summary.end_time.sec - robot.tasks[0].summary.start_time.sec - : '-'} + : '-'} */} - {robot.state.battery_percent.toFixed(2)}% - {robotMode} + {robot.battery ? robot.battery * 100 : 0}% + {robot.status} ); @@ -165,10 +160,10 @@ export interface RobotTableProps extends PaperProps { * The current list of robots to display, when pagination is enabled, this should only * contain the robots for the current page. */ - robots: VerboseRobot[]; + robots: RobotState[]; paginationOptions?: PaginationOptions; onRefreshClick?: React.MouseEventHandler; - onRobotClick?(ev: React.MouseEvent, robot: VerboseRobot): void; + onRobotClick?(ev: React.MouseEvent, robot: RobotState): void; } export function RobotTable({ diff --git a/packages/react-components/lib/robots/utils.ts b/packages/react-components/lib/robots/utils.ts index 29010439b..d0d31f578 100644 --- a/packages/react-components/lib/robots/utils.ts +++ b/packages/react-components/lib/robots/utils.ts @@ -1,4 +1,4 @@ -import type { RobotMode, Task } from 'api-client'; +import type { TaskState } from 'api-client'; import { RobotMode as RmfRobotMode, RobotState as RmfRobotState } from 'rmf-models'; /** @@ -8,7 +8,7 @@ export function robotHash(name: string, fleet: string): string { return `${name}__${fleet}`; } -export function robotModeToString(robotMode: RobotMode): string { +export function robotModeToString(robotMode: RmfRobotMode): string { switch (robotMode.mode) { case RmfRobotMode.MODE_CHARGING: return 'Charging'; @@ -35,5 +35,5 @@ export interface VerboseRobot { fleet: string; name: string; state: RmfRobotState; - tasks: Task[]; + tasks: TaskState[]; } diff --git a/packages/react-components/lib/tasks/create-task.tsx b/packages/react-components/lib/tasks/create-task.tsx index 8ab477751..f8719efb6 100644 --- a/packages/react-components/lib/tasks/create-task.tsx +++ b/packages/react-components/lib/tasks/create-task.tsx @@ -13,18 +13,18 @@ import { TextField, useTheme, } from '@mui/material'; -import { - CleanTaskDescription, - DeliveryTaskDescription, - LoopTaskDescription, - SubmitTask, -} from 'api-client'; +// import { +// CleanTaskDescription, +// DeliveryTaskDescription, +// LoopTaskDescription, +// SubmitTask, +// } from 'api-client'; import React from 'react'; import { TaskType as RmfTaskType } from 'rmf-models'; import { ConfirmationDialog, ConfirmationDialogProps } from '../confirmation-dialog'; import { PositiveIntField } from '../form-inputs'; -type TaskDescription = CleanTaskDescription | LoopTaskDescription | DeliveryTaskDescription; +type TaskDescription = any; const classes = { selectFileBtn: 'create-task-selected-file-btn', @@ -48,18 +48,18 @@ const StyledConfirmationDialog = styled((props: ConfirmationDialogProps) => ( }, })); -function getShortDescription(task: SubmitTask): string { +function getShortDescription(task: any): string { switch (task.task_type) { case RmfTaskType.TYPE_CLEAN: { - const desc = task.description as CleanTaskDescription; + const desc = task.description as any; return `[Clean] zone [${desc.cleaning_zone}]`; } case RmfTaskType.TYPE_DELIVERY: { - const desc = task.description as DeliveryTaskDescription; + const desc = task.description as any; return `[Delivery] from [${desc.pickup_place_name}] to [${desc.dropoff_place_name}]`; } case RmfTaskType.TYPE_LOOP: { - const desc = task.description as LoopTaskDescription; + const desc = task.description as any; return `[Loop] from [${desc.start_name}] to [${desc.finish_name}]`; } default: @@ -86,11 +86,11 @@ function FormToolbar({ onSelectFileClick }: FormToolbarProps) { } interface DeliveryTaskFormProps { - taskDesc: DeliveryTaskDescription; + taskDesc: any; deliveryWaypoints: string[]; dispensers: string[]; ingestors: string[]; - onChange(deliveryTaskDescription: DeliveryTaskDescription): void; + onChange(deliveryTaskDescription: any): void; } function DeliveryTaskForm({ @@ -209,9 +209,9 @@ function DeliveryTaskForm({ } interface LoopTaskFormProps { - taskDesc: LoopTaskDescription; + taskDesc: any; loopWaypoints: string[]; - onChange(loopTaskDescription: LoopTaskDescription): void; + onChange(loopTaskDescription: any): void; } function LoopTaskForm({ taskDesc, loopWaypoints, onChange }: LoopTaskFormProps) { @@ -286,9 +286,9 @@ function LoopTaskForm({ taskDesc, loopWaypoints, onChange }: LoopTaskFormProps) } interface CleanTaskFormProps { - taskDesc: CleanTaskDescription; + taskDesc: any; cleaningZones: string[]; - onChange(cleanTaskDescription: CleanTaskDescription): void; + onChange(cleanTaskDescription: any): void; } function CleanTaskForm({ taskDesc, cleaningZones, onChange }: CleanTaskFormProps) { @@ -314,13 +314,13 @@ function CleanTaskForm({ taskDesc, cleaningZones, onChange }: CleanTaskFormProps ); } -function defaultCleanTask(): CleanTaskDescription { +function defaultCleanTask(): any { return { cleaning_zone: '', }; } -function defaultLoopsTask(): LoopTaskDescription { +function defaultLoopsTask(): any { return { start_name: '', finish_name: '', @@ -328,7 +328,7 @@ function defaultLoopsTask(): LoopTaskDescription { }; } -function defaultDeliveryTask(): DeliveryTaskDescription { +function defaultDeliveryTask(): any { return { pickup_place_name: '', pickup_dispenser: '', @@ -350,7 +350,7 @@ function defaultTaskDescription(taskType?: number): TaskDescription | undefined } } -function defaultTask(): SubmitTask { +function defaultTask(): any { return { description: defaultCleanTask(), start_time: Math.floor(Date.now() / 1000), @@ -370,10 +370,10 @@ export interface CreateTaskFormProps deliveryWaypoints?: string[]; dispensers?: string[]; ingestors?: string[]; - submitTasks?(tasks: SubmitTask[]): Promise; - tasksFromFile?(): Promise | SubmitTask[]; - onSuccess?(tasks: SubmitTask[]): void; - onFail?(error: Error, tasks: SubmitTask[]): void; + submitTasks?(tasks: any[]): Promise; + tasksFromFile?(): Promise | any[]; + onSuccess?(tasks: any[]): void; + onFail?(error: Error, tasks: any[]): void; } export function CreateTaskForm({ @@ -389,7 +389,7 @@ export function CreateTaskForm({ ...otherProps }: CreateTaskFormProps): JSX.Element { const theme = useTheme(); - const [tasks, setTasks] = React.useState(() => [defaultTask()]); + const [tasks, setTasks] = React.useState(() => [defaultTask()]); const [selectedTaskIdx, setSelectedTaskIdx] = React.useState(0); const taskTitles = React.useMemo( () => tasks && tasks.map((t, i) => `${i + 1}: ${getShortDescription(t)}`), @@ -419,7 +419,7 @@ export function CreateTaskForm({ case RmfTaskType.TYPE_CLEAN: return ( handleTaskDescriptionChange(RmfTaskType.TYPE_CLEAN, desc)} /> @@ -427,7 +427,7 @@ export function CreateTaskForm({ case RmfTaskType.TYPE_LOOP: return ( handleTaskDescriptionChange(RmfTaskType.TYPE_LOOP, desc)} /> @@ -435,7 +435,7 @@ export function CreateTaskForm({ case RmfTaskType.TYPE_DELIVERY: return ( ) { } interface CleanTaskInfoProps { - task: TaskSummary; + task: TaskState; } function CleanTaskInfo({ task }: CleanTaskInfoProps) { return ( Start Waypoint: - {task.task_profile.description.clean.start_waypoint} + {parseTaskDetail(task, task?.category).to} ); } interface LoopTaskInfoProps { - task: TaskSummary; + task: TaskState; } function LoopTaskInfo({ task }: LoopTaskInfoProps) { @@ -51,75 +49,64 @@ function LoopTaskInfo({ task }: LoopTaskInfoProps) { <> Start Waypoint: - {task.task_profile.description.loop.start_name} + {parseTaskDetail(task, task?.category).from} Finish Waypoint: - {task.task_profile.description.loop.finish_name} + {parseTaskDetail(task, task?.category).to} Num of Loops: - {task.task_profile.description.loop.num_loops} + {task.phases ? Object.keys(task.phases).length / 2 : null} ); } interface DeliveryTaskInfoProps { - task: TaskSummary; + task: TaskState; } function DeliveryTaskInfoProps({ task }: DeliveryTaskInfoProps) { + // TODO - replace all temp values return ( <> Pickup Location: - - {task.task_profile.description.delivery.pickup_place_name} - + {'temp'} Pickup Dispenser: - - {task.task_profile.description.delivery.pickup_dispenser} - + {'temp'} Dropoff Location: - - {task.task_profile.description.delivery.dropoff_place_name} - + {parseTaskDetail(task, task?.category).from} Dropoff Ingestor: - - {task.task_profile.description.delivery.dropoff_ingestor} - + {parseTaskDetail(task, task?.category).to} ); } export interface TaskInfoProps { - task: TaskSummary; + task: TaskState; + showLogs: boolean; + onShowLogs?: React.Dispatch>; } -export function TaskInfo({ task }: TaskInfoProps): JSX.Element { +export function TaskInfo({ task, showLogs, onShowLogs }: TaskInfoProps): JSX.Element { const theme = useTheme(); - const taskType = task.task_profile.description.task_type.type; - const hasConcreteEndTime = [ - RmfTaskSummary.STATE_CANCELED, - RmfTaskSummary.STATE_COMPLETED, - RmfTaskSummary.STATE_FAILED, - ].includes(task.state); - + const taskType = task.category; const detailInfo = (() => { switch (taskType) { - case RmfTaskType.TYPE_CLEAN: + case 'Clean': return ; - case RmfTaskType.TYPE_LOOP: + case 'Loop': return ; - case RmfTaskType.TYPE_DELIVERY: + case 'Delivery': return ; default: return null; @@ -129,37 +116,24 @@ export function TaskInfo({ task }: TaskInfoProps): JSX.Element { return ( - {task.task_id} + {task.booking.id}
- - Task Type: - {taskTypeToStr(taskType)} - - - Priority: - {task.task_profile.description.priority.value} - - - Assigned Robot: - {task.robot_name} - - - Start Time: - {rosTimeToJs(task.start_time).toLocaleString()} - - - {!hasConcreteEndTime && 'Est. '}End Time: - {rosTimeToJs(task.end_time).toLocaleString()} - State: - {taskStateToStr(task.state)} + {getState(task)} {detailInfo} - Progress - +
+ Progress + +
+
+ +
); } diff --git a/packages/react-components/lib/tasks/task-phases.tsx b/packages/react-components/lib/tasks/task-phases.tsx index 4cbdd181d..7b319b4b8 100644 --- a/packages/react-components/lib/tasks/task-phases.tsx +++ b/packages/react-components/lib/tasks/task-phases.tsx @@ -1,5 +1,4 @@ import { Box, BoxProps, Grid, Theme, Tooltip, Typography, useTheme, styled } from '@mui/material'; -import type { TaskSummary } from 'api-client'; import clsx from 'clsx'; import React from 'react'; import { TaskSummary as RmfTaskSummary } from 'rmf-models'; @@ -98,7 +97,7 @@ function PhaseSeparator({ leftColor, rightColor }: PhaseSeparatorProps) { } export interface TaskPhasesProps extends BoxProps { - taskSummary: TaskSummary; + taskSummary: any; } export function TaskPhases({ taskSummary, ...boxProps }: TaskPhasesProps): JSX.Element { diff --git a/packages/react-components/lib/tasks/task-summary-accordion.tsx b/packages/react-components/lib/tasks/task-summary-accordion.tsx index 33f728ee6..1aeb9be3c 100644 --- a/packages/react-components/lib/tasks/task-summary-accordion.tsx +++ b/packages/react-components/lib/tasks/task-summary-accordion.tsx @@ -1,6 +1,6 @@ import React from 'react'; import Debug from 'debug'; -import type { TaskSummary } from 'api-client'; +// import type { TaskSummary } from 'api-client'; import { TaskSummary as RmfTaskSummary } from 'rmf-models'; import { IconButton, Typography, styled } from '@mui/material'; import { MultiSelectTreeViewProps, SingleSelectTreeViewProps, TreeItem, TreeView } from '@mui/lab'; @@ -14,7 +14,7 @@ import { formatStatus, getActorFromStatus, getStateLabel } from './task-summary- const debug = Debug('Tasks:TaskSummaryAccordion'); interface TaskSummaryAccordionInfoProps { - task: TaskSummary; + task: any; } interface TreeViewRootProps extends SingleSelectTreeViewProps { onNodeToggle?: MultiSelectTreeViewProps['onNodeSelect']; @@ -117,7 +117,7 @@ export const TaskSummaryAccordionInfo = (props: TaskSummaryAccordionInfoProps): }; export interface TaskSummaryAccordionProps { - tasks: TaskSummary[]; + tasks: any[]; } export const TaskSummaryAccordion = React.memo((props: TaskSummaryAccordionProps) => { @@ -159,7 +159,7 @@ export const TaskSummaryAccordion = React.memo((props: TaskSummaryAccordionProps ); }; - const renderTaskTreeItem = (task: TaskSummary) => { + const renderTaskTreeItem = (task: any) => { return ( { } }; -export const sortTasksBySubmissionTime = (tasks: TaskSummary[]): TaskSummary[] => { +export const sortTasksBySubmissionTime = (tasks: any[]): any[] => { if (tasks.length === 0) return []; return tasks.sort((a, b) => (a.submission_time.nanosec < b.submission_time.nanosec ? 1 : -1)); }; @@ -39,10 +39,10 @@ export const sortTasksBySubmissionTime = (tasks: TaskSummary[]): TaskSummary[] = * Classifies and stores each task by its state. */ export const separateTasksByState = ( - tasks: Record, + tasks: Record, states: string[], -): Record => { - const stateTasks: Record = {}; +): Record => { + const stateTasks: Record = {}; states.forEach((state) => { stateTasks[state] = []; }); @@ -72,11 +72,11 @@ export const separateTasksByState = ( /** * Sort tasks by state and by submission time, so what is active is always at the top of the list. */ -export const sortTasks = (tasks: Record): TaskSummary[] => { +export const sortTasks = (tasks: Record): any[] => { const states = ['active', 'queued', 'failed', 'completed', 'unknown']; const stateTasks = separateTasksByState(tasks, states); - const sortedTasks: TaskSummary[] = []; + const sortedTasks: any[] = []; states.forEach((state) => { sortedTasks.push(...sortTasksBySubmissionTime(stateTasks[state])); diff --git a/packages/react-components/lib/tasks/task-table.tsx b/packages/react-components/lib/tasks/task-table.tsx index bbaccdf9e..8bb67d319 100644 --- a/packages/react-components/lib/tasks/task-table.tsx +++ b/packages/react-components/lib/tasks/task-table.tsx @@ -7,16 +7,14 @@ import { TableProps, styled, } from '@mui/material'; -import type { TaskSummary, Time } from 'api-client'; +import type { TaskState, Time } from 'api-client'; import clsx from 'clsx'; -import { formatDistanceToNow } from 'date-fns'; +import { formatDistanceToNow, format } from 'date-fns'; import React from 'react'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; import { rosTimeToJs } from '../utils'; -import { taskStateToStr } from './utils'; +import { getState } from './utils'; const classes = { - table: 'task-table-table-root', taskRowHover: 'task-table-taskrow-hover', infoRow: 'task-table-info-row', phasesCell: 'task-table-phase-cell', @@ -30,9 +28,6 @@ const classes = { taskUnknownCell: 'task-table-unknown-cell', }; const StyledTable = styled((props: TableProps) => )(({ theme }) => ({ - [`&.${classes.table}`]: { - minWidth: 650, - }, [`& .${classes.taskRowHover}`]: { background: theme.palette.action.hover, cursor: 'pointer', @@ -83,34 +78,22 @@ const StyledTable = styled((props: TableProps) =>
)(({ theme })); interface TaskRowProps { - task: TaskSummary; + task: TaskState; onClick: React.MouseEventHandler; } function TaskRow({ task, onClick }: TaskRowProps) { + // replace all temp info const [hover, setHover] = React.useState(false); - const returnTaskStateCellClass = (task: TaskSummary) => { - switch (task.state) { - case RmfTaskSummary.STATE_ACTIVE: - return classes.taskActiveCell; - case RmfTaskSummary.STATE_CANCELED: - return classes.taskCancelledCell; - case RmfTaskSummary.STATE_COMPLETED: - return classes.taskCompletedCell; - case RmfTaskSummary.STATE_FAILED: - return classes.taskFailedCell; - case RmfTaskSummary.STATE_PENDING: - return classes.taskPendingCell; - case RmfTaskSummary.STATE_QUEUED: - return classes.taskQueuedCell; - default: - return classes.taskUnknownCell; - } + const returnTaskStateCellClass = (task: TaskState) => { + if (getState(task) === 'Underway') return classes.taskActiveCell; + if (getState(task) === 'Completed') return classes.taskCompletedCell; + return classes.taskUnknownCell; }; const taskStateCellClass = returnTaskStateCellClass(task); - + // TODO - replace robot name with something else return ( <> setHover(true)} onMouseOut={() => setHover(false)} > - {task.task_id} - {task.robot_name} - {toRelativeDate(task.start_time)} - {toRelativeDate(task.end_time)} - {taskStateToStr(task.state)} + {task.booking.id} + {'robotname'} + + {task.unix_millis_start_time + ? format(new Date(task.unix_millis_start_time * 1000), 'dd - mm - yyyy') + : '-'} + + + {task.unix_millis_finish_time + ? format(new Date(task.unix_millis_finish_time * 1000), 'dd - mm - yyyy') + : '-'} + + {task ? getState(task) : ''} ); @@ -138,18 +129,13 @@ export interface TaskTableProps { * The current list of tasks to display, when pagination is enabled, this should only * contain the tasks for the current page. */ - tasks: TaskSummary[]; - onTaskClick?(ev: React.MouseEvent, task: TaskSummary): void; + tasks: TaskState[]; + onTaskClick?(ev: React.MouseEvent, task: TaskState): void; } export function TaskTable({ tasks, onTaskClick }: TaskTableProps): JSX.Element { return ( - + Task Id @@ -162,7 +148,7 @@ export function TaskTable({ tasks, onTaskClick }: TaskTableProps): JSX.Element { {tasks.map((task) => ( onTaskClick && onTaskClick(ev, task)} /> diff --git a/packages/react-components/lib/tasks/task-timeline.stories.tsx b/packages/react-components/lib/tasks/task-timeline.stories.tsx index 3249ac523..4406ebbe9 100644 --- a/packages/react-components/lib/tasks/task-timeline.stories.tsx +++ b/packages/react-components/lib/tasks/task-timeline.stories.tsx @@ -1,8 +1,7 @@ import { Meta, Story } from '@storybook/react'; import React from 'react'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; import { TaskTimeline, TaskTimelineProps } from './task-timeline'; -import { makeTaskSummaryWithPhases } from './test-data.spec'; +import { TaskState } from 'api-client'; export default { title: 'Tasks/Timeline', @@ -12,9 +11,47 @@ export default { export const Timeline: Story = (args) => { return ; }; -const task = makeTaskSummaryWithPhases('test_task', 3, 3); -task.state = RmfTaskSummary.STATE_ACTIVE; +const task: TaskState = { + active: 1, + booking: { id: 'Loop1', unix_millis_earliest_start_time: 7856, priority: null, labels: null }, + cancellation: null, + category: 'Loop', + completed: [], + detail: {}, + estimate_millis: 1076180, + interruptions: null, + killed: null, + pending: [2, 3], + phases: { + '1': { + category: 'Go to [place:pantry]', + detail: 'Moving the robot from [place:tinyRobot1_charger] to [place:pantry]', + estimate_millis: 9597, + events: null, + final_event_id: 0, + id: 1, + }, + '2': { + category: 'Go to [place:supplies]', + detail: 'Moving the robot from [place:pantry] to [place:supplies]', + estimate_millis: 9597, + events: null, + final_event_id: 0, + id: 2, + }, + '3': { + category: 'Go to [place:pantry]', + detail: 'Moving the robot from [place:supplies] to [place:pantry]', + estimate_millis: 9597, + events: null, + final_event_id: 0, + id: 3, + }, + }, + unix_millis_finish_time: null, + unix_millis_start_time: null, +}; Timeline.args = { - taskSummary: task, + taskState: task, }; diff --git a/packages/react-components/lib/tasks/task-timeline.tsx b/packages/react-components/lib/tasks/task-timeline.tsx index 6764def01..c1fc96639 100644 --- a/packages/react-components/lib/tasks/task-timeline.tsx +++ b/packages/react-components/lib/tasks/task-timeline.tsx @@ -10,11 +10,15 @@ import { TimelineOppositeContent, TimelineSeparator, TimelineProps, + TreeView, + TreeItem, } from '@mui/lab'; -import type { TaskSummary } from 'api-client'; +import { TaskState } from 'api-client'; +import ExpandMoreIcon from '@mui/icons-material/ExpandMore'; +import ChevronRightIcon from '@mui/icons-material/ChevronRight'; import React from 'react'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; -import { rosTimeToJs } from '../utils'; +import { getTreeViewHeader } from './utils'; +import { format } from 'date-fns'; interface TimeLinePropsWithRef extends TimelineProps { ref?: React.RefObject; @@ -31,7 +35,8 @@ const classes = { const StyledTimeLine = styled((props: TimeLinePropsWithRef) => )( ({ theme }) => ({ [`& .${classes.paper}`]: { - padding: '6px 16px', + padding: theme.spacing(1), + marginTop: theme.spacing(1), width: '200px', maxHeight: '100px', overflow: 'auto', @@ -55,64 +60,102 @@ const StyledTimeLine = styled((props: TimeLinePropsWithRef) => msg.startsWith('*')); - const timelineInfo = taskSummary.status.split('\n\n'); - - const timelineDotProps = timelinePhases.map((_: string, idx: number) => { - if ([RmfTaskSummary.STATE_CANCELED, RmfTaskSummary.STATE_FAILED].includes(taskSummary.state)) { - return { - className: classes.failedPhase, - }; +function LoopTaskTree({ task }: TaskTreeProps) { + const timelinePhases = task.phases; + // TODO - remove if a timeline for estimated fisnishing time is not needed + // let totalTimeTaken = 0; + // timelinePhases && + // Object.keys(timelinePhases).forEach((p) => { + // const estimateMillis = timelinePhases[p].estimate_millis; + // if (estimateMillis) totalTimeTaken += estimateMillis * 1000; + // }); + function getTimeLineDotProps(taskState: TaskState) { + if (taskState.active) return { className: classes.completedPhase }; + else { + return { className: classes.failedPhase }; } + } + return timelinePhases ? ( + + + + {format(new Date(), "hh:mm aaaaa'm'")} + + + + + + + + } defaultExpandIcon={}> + + { + return ( + + {timelinePhases[phase].detail} + + ); + })} + /> + + + + + ) : null; +} - if (taskSummary.state === RmfTaskSummary.STATE_COMPLETED) { - return { - className: classes.completedPhase, - }; - } +function DeliveryTaskTree({ task }: TaskTreeProps) { + // TODO - get timeline dot props, get ingestor and dispenser information? + return ( + + + + {format(new Date(), "hh:mm aaaaa'm'")} + + + + + + + + } defaultExpandIcon={}> + + + + + + + ); +} - if (taskSummary.state === RmfTaskSummary.STATE_ACTIVE && idx < currentDotIdx) { - return { - className: classes.completedPhase, - }; - } +export interface TaskTimelineProps { + taskState: TaskState; +} - return { - className: classes.pendingPhase, - }; - }); +export function TaskTimeline({ taskState }: TaskTimelineProps): JSX.Element { + // TODO - leaving here for reference for other treeviews + // function getTimeLineDotProps(taskState: TaskState, taskPhase: Phase) { + // if (taskState.completed?.includes(taskPhase.id)) return { className: classes.completedPhase }; + // if (taskPhase.id === taskState.active) return { className: classes.completedPhase }; + // if (taskState.pending?.includes(taskPhase.id)) return { className: classes.completedPhase }; + // else { + // return { className: classes.failedPhase }; + // } + // } + function GetTreeView(category: string) { + if (category.includes('Loop')) return ; + if (category.includes('Delivery')) return ; + } return ( - - {timelineInfo.map((dotInfo, idx) => { - return ( - - - - {idx === 0 && rosTimeToJs(taskSummary.start_time).toLocaleTimeString()} - {idx > 0 && - idx === timelineInfo.length - 1 && - rosTimeToJs(taskSummary.end_time).toLocaleTimeString()} - - - - - {idx < timelineInfo.length - 1 && } - - - - {dotInfo} - - - - ); - })} + + {taskState.category ? GetTreeView(taskState.category) : null} ); } diff --git a/packages/react-components/lib/tasks/utils.ts b/packages/react-components/lib/tasks/utils.ts index e5c46808b..cd2b766c7 100644 --- a/packages/react-components/lib/tasks/utils.ts +++ b/packages/react-components/lib/tasks/utils.ts @@ -1,21 +1,13 @@ import { TaskSummary as RmfTaskSummary, TaskType as RmfTaskType } from 'rmf-models'; +import type { TaskState } from 'api-client'; -export function taskStateToStr(state: number): string { - switch (state) { - case RmfTaskSummary.STATE_ACTIVE: - return 'Active'; - case RmfTaskSummary.STATE_CANCELED: - return 'Cancelled'; - case RmfTaskSummary.STATE_COMPLETED: - return 'Completed'; - case RmfTaskSummary.STATE_FAILED: - return 'Failed'; - case RmfTaskSummary.STATE_PENDING: - return 'Pending'; - case RmfTaskSummary.STATE_QUEUED: - return 'Queued'; - default: - return 'Unknown'; +export function taskStateToStr(taskState: TaskState): string { + if (taskState.active) return 'active'; + if (taskState.cancellation) return 'cancelled'; + if (taskState.killed) return 'killed'; + if (taskState.pending?.length === 0) return 'completed'; + else { + return 'unknown'; } } @@ -37,3 +29,49 @@ export function taskTypeToStr(taskType: number): string { return 'Unknown'; } } + +function parsePhaseDetail(phases: TaskState['phases'], category?: string) { + if (phases) { + if (category === 'Loop') { + const startPhase = phases['1']; + const endPhase = phases['2']; + const from = startPhase.category?.split('[place:')[1].split(']')[0]; + const to = endPhase.category?.split('[place:')[1].split(']')[0]; + return { to, from }; + } + } + return {}; +} + +export function parseTaskDetail(task: TaskState, category?: string) { + if (category?.includes('Loop')) return parsePhaseDetail(task.phases, category); + if (category?.includes('Delivery')) { + const from = category?.split('[place:')[1].split(']')[0]; + const to = category?.split('[place:')[2].split(']')[0]; + return { to, from }; + } else { + return {}; + } +} + +export function getState(task: TaskState) { + // TODO - handle killed and cancelled states + if (task.phases && task.completed?.length === Object.keys(task.phases).length) return 'Completed'; + if (task.active) return 'Underway'; + return ''; +} + +export function getTreeViewHeader(category: TaskState['category']) { + switch (category) { + case 'Loop': + return 'Loop Sequence'; + case 'Clean': + return 'Clean Sequence'; + case 'Delivery': + // TODO - not sure about return structure, + // once able to receive delivery task + // come back again. + default: + return ''; + } +} From 35f60d563c8781f8c2769d30b393377a1741cdbd Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 10 Jan 2022 02:02:23 +0000 Subject: [PATCH 22/79] update models Signed-off-by: Teo Koon Peng --- packages/api-client/lib/openapi/api.ts | 267 ++++++++++++++++++++----- packages/api-client/lib/version.ts | 2 +- 2 files changed, 220 insertions(+), 49 deletions(-) diff --git a/packages/api-client/lib/openapi/api.ts b/packages/api-client/lib/openapi/api.ts index 4763b378b..ccfbfd0ec 100644 --- a/packages/api-client/lib/openapi/api.ts +++ b/packages/api-client/lib/openapi/api.ts @@ -80,6 +80,44 @@ export interface AffineImage { */ data: string; } +/** + * + * @export + * @interface AssignedTo + */ +export interface AssignedTo { + /** + * + * @type {string} + * @memberof AssignedTo + */ + group: string; + /** + * + * @type {string} + * @memberof AssignedTo + */ + name: string; +} +/** + * + * @export + * @interface Assignment + */ +export interface Assignment { + /** + * + * @type {string} + * @memberof Assignment + */ + fleet_name?: string; + /** + * + * @type {string} + * @memberof Assignment + */ + expected_robot_name?: string; +} /** * * @export @@ -180,25 +218,37 @@ export interface Cancellation { */ labels: Array; } +/** + * Detailed information about a task, phase, or event + * @export + * @interface Detail + */ +export interface Detail {} /** * * @export - * @interface Description + * @interface Dispatch */ -export interface Description { +export interface Dispatch { /** * - * @type {string} - * @memberof Description + * @type {Status1} + * @memberof Dispatch */ - category: string; + status: Status1; + /** + * + * @type {Assignment} + * @memberof Dispatch + */ + assignment?: Assignment; + /** + * + * @type {Array} + * @memberof Dispatch + */ + errors?: Array; } -/** - * Detailed information about a task, phase, or event - * @export - * @interface Detail - */ -export interface Detail {} /** * * @export @@ -418,11 +468,11 @@ export interface EventState { */ id: number; /** - * A simple token representing how the task is proceeding - * @type {Status1} + * + * @type {Status} * @memberof EventState */ - status?: Status1; + status?: Status; /** * The brief name of the event * @type {string} @@ -1130,6 +1180,24 @@ export interface Phase { * @memberof Phase */ detail?: Detail; + /** + * + * @type {number} + * @memberof Phase + */ + unix_millis_start_time?: number; + /** + * + * @type {number} + * @memberof Phase + */ + unix_millis_finish_time?: number; + /** + * An estimate, in milliseconds, of how long the subject will take to complete + * @type {number} + * @memberof Phase + */ + original_estimate_millis?: number; /** * An estimate, in milliseconds, of how long the subject will take to complete * @type {number} @@ -1155,6 +1223,25 @@ export interface Phase { */ skip_requests?: { [key: string]: SkipPhaseRequest }; } +/** + * + * @export + * @interface Phases + */ +export interface Phases { + /** + * Log entries related to the overall phase + * @type {Array} + * @memberof Phases + */ + log?: Array; + /** + * A dictionary whose keys (property names) are the indices of an event in the phase + * @type {{ [key: string]: Array; }} + * @memberof Phases + */ + events?: { [key: string]: Array }; +} /** * * @export @@ -1276,10 +1363,10 @@ export interface RobotState { name?: string; /** * A simple token representing the status of the robot - * @type {Status} + * @type {Status2} * @memberof RobotState */ - status?: Status; + status?: Status2; /** * The ID of the task this robot is currently working on. Empty string if the robot is not working on a task. * @type {string} @@ -1395,12 +1482,17 @@ export interface SkipPhaseRequest { export enum Status { Uninitialized = 'uninitialized', - Offline = 'offline', - Shutdown = 'shutdown', - Idle = 'idle', - Charging = 'charging', - Working = 'working', + Blocked = 'blocked', Error = 'error', + Failed = 'failed', + Queued = 'queued', + Standby = 'standby', + Underway = 'underway', + Delayed = 'delayed', + Skipped = 'skipped', + Canceled = 'canceled', + Killed = 'killed', + Completed = 'completed', } /** @@ -1410,17 +1502,27 @@ export enum Status { */ export enum Status1 { + Queued = 'queued', + Selected = 'selected', + Dispatched = 'dispatched', + FailedToAssign = 'failed_to_assign', + CanceledInFlight = 'canceled_in_flight', +} + +/** + * An enumeration. + * @export + * @enum {string} + */ + +export enum Status2 { Uninitialized = 'uninitialized', - Blocked = 'blocked', + Offline = 'offline', + Shutdown = 'shutdown', + Idle = 'idle', + Charging = 'charging', + Working = 'working', Error = 'error', - Failed = 'failed', - Standby = 'standby', - Underway = 'underway', - Delayed = 'delayed', - Skipped = 'skipped', - Canceled = 'canceled', - Killed = 'killed', - Completed = 'completed', } /** @@ -1462,10 +1564,10 @@ export interface TaskEventLog { log?: Array; /** * A dictionary whose keys (property names) are the indices of a phase - * @type {{ [key: string]: object; }} + * @type {{ [key: string]: Phases; }} * @memberof TaskEventLog */ - phases?: { [key: string]: object }; + phases?: { [key: string]: Phases }; } /** * @@ -1486,11 +1588,23 @@ export interface TaskRequest { */ priority?: object; /** - * A description of the task. This must match a schema supported by a fleet. - * @type {Description} + * + * @type {string} + * @memberof TaskRequest + */ + category: string; + /** + * A description of the task. This must match a schema supported by a fleet for the category of this task request. + * @type {any} + * @memberof TaskRequest + */ + description: any | null; + /** + * Labels to describe the purpose of the task dispatch request + * @type {Array} * @memberof TaskRequest */ - description: Description; + labels?: Array; } /** * @@ -1528,12 +1642,36 @@ export interface TaskState { * @memberof TaskState */ unix_millis_finish_time?: number; + /** + * An estimate, in milliseconds, of how long the subject will take to complete + * @type {number} + * @memberof TaskState + */ + original_estimate_millis?: number; /** * An estimate, in milliseconds, of how long the subject will take to complete * @type {number} * @memberof TaskState */ estimate_millis?: number; + /** + * Which agent (robot) is the task assigned to + * @type {AssignedTo} + * @memberof TaskState + */ + assigned_to?: AssignedTo; + /** + * + * @type {Status} + * @memberof TaskState + */ + status?: Status; + /** + * + * @type {Dispatch} + * @memberof TaskState + */ + dispatch?: Dispatch; /** * A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers. * @type {{ [key: string]: Phase; }} @@ -3275,7 +3413,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati }; }, /** - * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"description\": \"A simple token representing how the task is proceeding\", \"allOf\": [ { \"$ref\": \"#/definitions/Status1\" } ] }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"object\" } } }, \"required\": [ \"task_id\" ], \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` + * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"original_estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"assigned_to\": { \"title\": \"Assigned To\", \"description\": \"Which agent (robot) is the task assigned to\", \"allOf\": [ { \"$ref\": \"#/definitions/AssignedTo\" } ] }, \"status\": { \"$ref\": \"#/definitions/Status\" }, \"dispatch\": { \"$ref\": \"#/definitions/Dispatch\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"AssignedTo\": { \"title\": \"AssignedTo\", \"type\": \"object\", \"properties\": { \"group\": { \"title\": \"Group\", \"type\": \"string\" }, \"name\": { \"title\": \"Name\", \"type\": \"string\" } }, \"required\": [ \"group\", \"name\" ] }, \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"queued\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"queued\", \"selected\", \"dispatched\", \"failed_to_assign\", \"canceled_in_flight\" ] }, \"Assignment\": { \"title\": \"Assignment\", \"type\": \"object\", \"properties\": { \"fleet_name\": { \"title\": \"Fleet Name\", \"type\": \"string\" }, \"expected_robot_name\": { \"title\": \"Expected Robot Name\", \"type\": \"string\" } } }, \"Error\": { \"title\": \"Error\", \"type\": \"object\", \"properties\": { \"code\": { \"title\": \"Code\", \"description\": \"A standard code for the kind of error that has occurred\", \"minimum\": 0, \"type\": \"integer\" }, \"category\": { \"title\": \"Category\", \"description\": \"The category of the error\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Details about the error\", \"type\": \"string\" } } }, \"Dispatch\": { \"title\": \"Dispatch\", \"type\": \"object\", \"properties\": { \"status\": { \"$ref\": \"#/definitions/Status1\" }, \"assignment\": { \"$ref\": \"#/definitions/Assignment\" }, \"errors\": { \"title\": \"Errors\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Error\" } } }, \"required\": [ \"status\" ] }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"$ref\": \"#/definitions/Status\" }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"original_estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phases\" } } }, \"required\": [ \"task_id\" ], \"additionalProperties\": false, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] }, \"Phases\": { \"title\": \"Phases\", \"type\": \"object\", \"properties\": { \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall phase\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary whose keys (property names) are the indices of an event in the phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"additionalProperties\": false } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status2\": { \"title\": \"Status2\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status2\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` * @summary Socket.io endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3342,7 +3480,7 @@ export const DefaultApiFp = function (configuration?: Configuration) { return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, /** - * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"description\": \"A simple token representing how the task is proceeding\", \"allOf\": [ { \"$ref\": \"#/definitions/Status1\" } ] }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"object\" } } }, \"required\": [ \"task_id\" ], \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` + * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"original_estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"assigned_to\": { \"title\": \"Assigned To\", \"description\": \"Which agent (robot) is the task assigned to\", \"allOf\": [ { \"$ref\": \"#/definitions/AssignedTo\" } ] }, \"status\": { \"$ref\": \"#/definitions/Status\" }, \"dispatch\": { \"$ref\": \"#/definitions/Dispatch\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"AssignedTo\": { \"title\": \"AssignedTo\", \"type\": \"object\", \"properties\": { \"group\": { \"title\": \"Group\", \"type\": \"string\" }, \"name\": { \"title\": \"Name\", \"type\": \"string\" } }, \"required\": [ \"group\", \"name\" ] }, \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"queued\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"queued\", \"selected\", \"dispatched\", \"failed_to_assign\", \"canceled_in_flight\" ] }, \"Assignment\": { \"title\": \"Assignment\", \"type\": \"object\", \"properties\": { \"fleet_name\": { \"title\": \"Fleet Name\", \"type\": \"string\" }, \"expected_robot_name\": { \"title\": \"Expected Robot Name\", \"type\": \"string\" } } }, \"Error\": { \"title\": \"Error\", \"type\": \"object\", \"properties\": { \"code\": { \"title\": \"Code\", \"description\": \"A standard code for the kind of error that has occurred\", \"minimum\": 0, \"type\": \"integer\" }, \"category\": { \"title\": \"Category\", \"description\": \"The category of the error\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Details about the error\", \"type\": \"string\" } } }, \"Dispatch\": { \"title\": \"Dispatch\", \"type\": \"object\", \"properties\": { \"status\": { \"$ref\": \"#/definitions/Status1\" }, \"assignment\": { \"$ref\": \"#/definitions/Assignment\" }, \"errors\": { \"title\": \"Errors\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Error\" } } }, \"required\": [ \"status\" ] }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"$ref\": \"#/definitions/Status\" }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"original_estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phases\" } } }, \"required\": [ \"task_id\" ], \"additionalProperties\": false, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] }, \"Phases\": { \"title\": \"Phases\", \"type\": \"object\", \"properties\": { \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall phase\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary whose keys (property names) are the indices of an event in the phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"additionalProperties\": false } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status2\": { \"title\": \"Status2\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status2\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` * @summary Socket.io endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3388,7 +3526,7 @@ export const DefaultApiFactory = function ( return localVarFp.getUserUserGet(options).then((request) => request(axios, basePath)); }, /** - * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"description\": \"A simple token representing how the task is proceeding\", \"allOf\": [ { \"$ref\": \"#/definitions/Status1\" } ] }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"object\" } } }, \"required\": [ \"task_id\" ], \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` + * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"original_estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"assigned_to\": { \"title\": \"Assigned To\", \"description\": \"Which agent (robot) is the task assigned to\", \"allOf\": [ { \"$ref\": \"#/definitions/AssignedTo\" } ] }, \"status\": { \"$ref\": \"#/definitions/Status\" }, \"dispatch\": { \"$ref\": \"#/definitions/Dispatch\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"AssignedTo\": { \"title\": \"AssignedTo\", \"type\": \"object\", \"properties\": { \"group\": { \"title\": \"Group\", \"type\": \"string\" }, \"name\": { \"title\": \"Name\", \"type\": \"string\" } }, \"required\": [ \"group\", \"name\" ] }, \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"queued\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"queued\", \"selected\", \"dispatched\", \"failed_to_assign\", \"canceled_in_flight\" ] }, \"Assignment\": { \"title\": \"Assignment\", \"type\": \"object\", \"properties\": { \"fleet_name\": { \"title\": \"Fleet Name\", \"type\": \"string\" }, \"expected_robot_name\": { \"title\": \"Expected Robot Name\", \"type\": \"string\" } } }, \"Error\": { \"title\": \"Error\", \"type\": \"object\", \"properties\": { \"code\": { \"title\": \"Code\", \"description\": \"A standard code for the kind of error that has occurred\", \"minimum\": 0, \"type\": \"integer\" }, \"category\": { \"title\": \"Category\", \"description\": \"The category of the error\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Details about the error\", \"type\": \"string\" } } }, \"Dispatch\": { \"title\": \"Dispatch\", \"type\": \"object\", \"properties\": { \"status\": { \"$ref\": \"#/definitions/Status1\" }, \"assignment\": { \"$ref\": \"#/definitions/Assignment\" }, \"errors\": { \"title\": \"Errors\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Error\" } } }, \"required\": [ \"status\" ] }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"$ref\": \"#/definitions/Status\" }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"original_estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phases\" } } }, \"required\": [ \"task_id\" ], \"additionalProperties\": false, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] }, \"Phases\": { \"title\": \"Phases\", \"type\": \"object\", \"properties\": { \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall phase\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary whose keys (property names) are the indices of an event in the phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"additionalProperties\": false } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status2\": { \"title\": \"Status2\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status2\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` * @summary Socket.io endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -3433,7 +3571,7 @@ export class DefaultApi extends BaseAPI { } /** - * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"description\": \"A simple token representing how the task is proceeding\", \"allOf\": [ { \"$ref\": \"#/definitions/Status1\" } ] }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"object\" } } }, \"required\": [ \"task_id\" ], \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` + * # NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint. ## About This exposes a minimal pubsub system built on top of socket.io. It works similar to a normal socket.io endpoint, except that are 2 special rooms which control subscriptions. ## Rooms ### subscribe Clients must send a message to this room to start receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### unsubscribe Clients can send a message to this room to stop receiving messages on other rooms. The message must be of the form: ``` { \"room\": \"\" } ``` ### /building_map ``` { \"title\": \"BuildingMap\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Level\" } }, \"lifts\": { \"title\": \"Lifts\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Lift\" } } }, \"required\": [ \"name\", \"levels\", \"lifts\" ], \"definitions\": { \"AffineImage\": { \"title\": \"AffineImage\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x_offset\": { \"title\": \"X Offset\", \"default\": 0, \"type\": \"number\" }, \"y_offset\": { \"title\": \"Y Offset\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"scale\": { \"title\": \"Scale\", \"default\": 0, \"type\": \"number\" }, \"encoding\": { \"title\": \"Encoding\", \"default\": \"\", \"type\": \"string\" }, \"data\": { \"title\": \"Data\", \"type\": \"string\" } }, \"required\": [ \"name\", \"x_offset\", \"y_offset\", \"yaw\", \"scale\", \"encoding\", \"data\" ] }, \"Place\": { \"title\": \"Place\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"default\": 0, \"type\": \"number\" }, \"position_tolerance\": { \"title\": \"Position Tolerance\", \"default\": 0, \"type\": \"number\" }, \"yaw_tolerance\": { \"title\": \"Yaw Tolerance\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"x\", \"y\", \"yaw\", \"position_tolerance\", \"yaw_tolerance\" ] }, \"Door\": { \"title\": \"Door\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"v1_x\": { \"title\": \"V1 X\", \"default\": 0, \"type\": \"number\" }, \"v1_y\": { \"title\": \"V1 Y\", \"default\": 0, \"type\": \"number\" }, \"v2_x\": { \"title\": \"V2 X\", \"default\": 0, \"type\": \"number\" }, \"v2_y\": { \"title\": \"V2 Y\", \"default\": 0, \"type\": \"number\" }, \"door_type\": { \"title\": \"Door Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_range\": { \"title\": \"Motion Range\", \"default\": 0, \"type\": \"number\" }, \"motion_direction\": { \"title\": \"Motion Direction\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" } }, \"required\": [ \"name\", \"v1_x\", \"v1_y\", \"v2_x\", \"v2_y\", \"door_type\", \"motion_range\", \"motion_direction\" ] }, \"Param\": { \"title\": \"Param\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"type\": { \"title\": \"Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"value_int\": { \"title\": \"Value Int\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"value_float\": { \"title\": \"Value Float\", \"default\": 0, \"type\": \"number\" }, \"value_string\": { \"title\": \"Value String\", \"default\": \"\", \"type\": \"string\" }, \"value_bool\": { \"title\": \"Value Bool\", \"default\": false, \"type\": \"boolean\" } }, \"required\": [ \"name\", \"type\", \"value_int\", \"value_float\", \"value_string\", \"value_bool\" ] }, \"GraphNode\": { \"title\": \"GraphNode\", \"type\": \"object\", \"properties\": { \"x\": { \"title\": \"X\", \"default\": 0, \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"default\": 0, \"type\": \"number\" }, \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"x\", \"y\", \"name\", \"params\" ] }, \"GraphEdge\": { \"title\": \"GraphEdge\", \"type\": \"object\", \"properties\": { \"v1_idx\": { \"title\": \"V1 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"v2_idx\": { \"title\": \"V2 Idx\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } }, \"edge_type\": { \"title\": \"Edge Type\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" } }, \"required\": [ \"v1_idx\", \"v2_idx\", \"params\", \"edge_type\" ] }, \"Graph\": { \"title\": \"Graph\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"vertices\": { \"title\": \"Vertices\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphNode\" } }, \"edges\": { \"title\": \"Edges\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/GraphEdge\" } }, \"params\": { \"title\": \"Params\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Param\" } } }, \"required\": [ \"name\", \"vertices\", \"edges\", \"params\" ] }, \"Level\": { \"title\": \"Level\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"elevation\": { \"title\": \"Elevation\", \"default\": 0, \"type\": \"number\" }, \"images\": { \"title\": \"Images\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/AffineImage\" } }, \"places\": { \"title\": \"Places\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Place\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"nav_graphs\": { \"title\": \"Nav Graphs\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Graph\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] } }, \"required\": [ \"name\", \"elevation\", \"images\", \"places\", \"doors\", \"nav_graphs\", \"wall_graph\" ] }, \"Lift\": { \"title\": \"Lift\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"default\": \"\", \"type\": \"string\" }, \"levels\": { \"title\": \"Levels\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"doors\": { \"title\": \"Doors\", \"default\": [], \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Door\" } }, \"wall_graph\": { \"title\": \"Wall Graph\", \"default\": { \"name\": \"\", \"vertices\": [], \"edges\": [], \"params\": [] }, \"allOf\": [ { \"$ref\": \"#/definitions/Graph\" } ] }, \"ref_x\": { \"title\": \"Ref X\", \"default\": 0, \"type\": \"number\" }, \"ref_y\": { \"title\": \"Ref Y\", \"default\": 0, \"type\": \"number\" }, \"ref_yaw\": { \"title\": \"Ref Yaw\", \"default\": 0, \"type\": \"number\" }, \"width\": { \"title\": \"Width\", \"default\": 0, \"type\": \"number\" }, \"depth\": { \"title\": \"Depth\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"name\", \"levels\", \"doors\", \"wall_graph\", \"ref_x\", \"ref_y\", \"ref_yaw\", \"width\", \"depth\" ] } } } ``` ### /doors/{door_name}/state ``` { \"title\": \"DoorState\", \"type\": \"object\", \"properties\": { \"door_time\": { \"title\": \"Door Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"door_name\": { \"title\": \"Door Name\", \"default\": \"\", \"type\": \"string\" }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": { \"value\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/DoorMode\" } ] } }, \"required\": [ \"door_time\", \"door_name\", \"current_mode\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] }, \"DoorMode\": { \"title\": \"DoorMode\", \"type\": \"object\", \"properties\": { \"value\": { \"title\": \"Value\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"value\" ] } } } ``` ### /doors/{door_name}/health ``` { \"title\": \"DoorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /lifts/{lift_name}/state ``` { \"title\": \"LiftState\", \"type\": \"object\", \"properties\": { \"lift_time\": { \"title\": \"Lift Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"lift_name\": { \"title\": \"Lift Name\", \"default\": \"\", \"type\": \"string\" }, \"available_floors\": { \"title\": \"Available Floors\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"current_floor\": { \"title\": \"Current Floor\", \"default\": \"\", \"type\": \"string\" }, \"destination_floor\": { \"title\": \"Destination Floor\", \"default\": \"\", \"type\": \"string\" }, \"door_state\": { \"title\": \"Door State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"motion_state\": { \"title\": \"Motion State\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"available_modes\": { \"title\": \"Available Modes\", \"type\": \"array\", \"items\": { \"type\": \"integer\" } }, \"current_mode\": { \"title\": \"Current Mode\", \"default\": 0, \"minimum\": 0, \"maximum\": 255, \"type\": \"integer\" }, \"session_id\": { \"title\": \"Session Id\", \"default\": \"\", \"type\": \"string\" } }, \"required\": [ \"lift_time\", \"lift_name\", \"available_floors\", \"current_floor\", \"destination_floor\", \"door_state\", \"motion_state\", \"available_modes\", \"current_mode\", \"session_id\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /lifts/{lift_name}/health ``` { \"title\": \"LiftHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /tasks/{task_id}/state ``` { \"title\": \"TaskState\", \"type\": \"object\", \"properties\": { \"booking\": { \"$ref\": \"#/definitions/Booking\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"original_estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"assigned_to\": { \"title\": \"Assigned To\", \"description\": \"Which agent (robot) is the task assigned to\", \"allOf\": [ { \"$ref\": \"#/definitions/AssignedTo\" } ] }, \"status\": { \"$ref\": \"#/definitions/Status\" }, \"dispatch\": { \"$ref\": \"#/definitions/Dispatch\" }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phase\" } }, \"completed\": { \"title\": \"Completed\", \"description\": \"An array of the IDs of completed phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"active\": { \"title\": \"Active\", \"description\": \"The ID of the active phase for this task\", \"allOf\": [ { \"$ref\": \"#/definitions/Id\" } ] }, \"pending\": { \"title\": \"Pending\", \"description\": \"An array of the pending phases of this task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Id\" } }, \"interruptions\": { \"title\": \"Interruptions\", \"description\": \"A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Interruption\" } }, \"cancellation\": { \"title\": \"Cancellation\", \"description\": \"If the task was cancelled, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Cancellation\" } ] }, \"killed\": { \"title\": \"Killed\", \"description\": \"If the task was killed, this will describe information about the request.\", \"allOf\": [ { \"$ref\": \"#/definitions/Killed\" } ] } }, \"required\": [ \"booking\" ], \"definitions\": { \"Booking\": { \"title\": \"Booking\", \"type\": \"object\", \"properties\": { \"id\": { \"title\": \"Id\", \"description\": \"The unique identifier for this task\", \"type\": \"string\" }, \"unix_millis_earliest_start_time\": { \"title\": \"Unix Millis Earliest Start Time\", \"type\": \"integer\" }, \"priority\": { \"title\": \"Priority\", \"description\": \"Priority information about this task\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"string\" } ] }, \"labels\": { \"title\": \"Labels\", \"description\": \"Information about how and why this task was booked\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"id\" ] }, \"Category\": { \"title\": \"Category\", \"description\": \"The category of this task or phase\", \"type\": \"string\" }, \"Detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about a task, phase, or event\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] }, \"EstimateMillis\": { \"title\": \"EstimateMillis\", \"description\": \"An estimate, in milliseconds, of how long the subject will take to complete\", \"minimum\": 0, \"type\": \"integer\" }, \"AssignedTo\": { \"title\": \"AssignedTo\", \"type\": \"object\", \"properties\": { \"group\": { \"title\": \"Group\", \"type\": \"string\" }, \"name\": { \"title\": \"Name\", \"type\": \"string\" } }, \"required\": [ \"group\", \"name\" ] }, \"Status\": { \"title\": \"Status\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"blocked\", \"error\", \"failed\", \"queued\", \"standby\", \"underway\", \"delayed\", \"skipped\", \"canceled\", \"killed\", \"completed\" ] }, \"Status1\": { \"title\": \"Status1\", \"description\": \"An enumeration.\", \"enum\": [ \"queued\", \"selected\", \"dispatched\", \"failed_to_assign\", \"canceled_in_flight\" ] }, \"Assignment\": { \"title\": \"Assignment\", \"type\": \"object\", \"properties\": { \"fleet_name\": { \"title\": \"Fleet Name\", \"type\": \"string\" }, \"expected_robot_name\": { \"title\": \"Expected Robot Name\", \"type\": \"string\" } } }, \"Error\": { \"title\": \"Error\", \"type\": \"object\", \"properties\": { \"code\": { \"title\": \"Code\", \"description\": \"A standard code for the kind of error that has occurred\", \"minimum\": 0, \"type\": \"integer\" }, \"category\": { \"title\": \"Category\", \"description\": \"The category of the error\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Details about the error\", \"type\": \"string\" } } }, \"Dispatch\": { \"title\": \"Dispatch\", \"type\": \"object\", \"properties\": { \"status\": { \"$ref\": \"#/definitions/Status1\" }, \"assignment\": { \"$ref\": \"#/definitions/Assignment\" }, \"errors\": { \"title\": \"Errors\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Error\" } } }, \"required\": [ \"status\" ] }, \"Id\": { \"title\": \"Id\", \"minimum\": 0, \"type\": \"integer\" }, \"EventState\": { \"title\": \"EventState\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"status\": { \"$ref\": \"#/definitions/Status\" }, \"name\": { \"title\": \"Name\", \"description\": \"The brief name of the event\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the event\", \"allOf\": [ { \"$ref\": \"#/definitions/Detail\" } ] }, \"deps\": { \"title\": \"Deps\", \"description\": \"This event may depend on other events. This array contains the IDs of those other event dependencies.\", \"type\": \"array\", \"items\": { \"type\": \"integer\", \"minimum\": 0 } } }, \"required\": [ \"id\" ] }, \"Undo\": { \"title\": \"Undo\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the undo skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the undo skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"SkipPhaseRequest\": { \"title\": \"SkipPhaseRequest\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the skip request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the skip request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"undo\": { \"title\": \"Undo\", \"description\": \"Information about an undo skip request that applied to this request\", \"allOf\": [ { \"$ref\": \"#/definitions/Undo\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Phase\": { \"title\": \"Phase\", \"type\": \"object\", \"properties\": { \"id\": { \"$ref\": \"#/definitions/Id\" }, \"category\": { \"$ref\": \"#/definitions/Category\" }, \"detail\": { \"$ref\": \"#/definitions/Detail\" }, \"unix_millis_start_time\": { \"title\": \"Unix Millis Start Time\", \"type\": \"integer\" }, \"unix_millis_finish_time\": { \"title\": \"Unix Millis Finish Time\", \"type\": \"integer\" }, \"original_estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"estimate_millis\": { \"$ref\": \"#/definitions/EstimateMillis\" }, \"final_event_id\": { \"$ref\": \"#/definitions/Id\" }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/EventState\" } }, \"skip_requests\": { \"title\": \"Skip Requests\", \"description\": \"Information about any skip requests that have been received\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/SkipPhaseRequest\" } } }, \"required\": [ \"id\" ] }, \"ResumedBy\": { \"title\": \"ResumedBy\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the resume request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the resume request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"labels\" ] }, \"Interruption\": { \"title\": \"Interruption\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the interruption request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the purpose of the interruption\", \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"resumed_by\": { \"title\": \"Resumed By\", \"description\": \"Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.\", \"allOf\": [ { \"$ref\": \"#/definitions/ResumedBy\" } ] } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Cancellation\": { \"title\": \"Cancellation\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the cancel request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] }, \"Killed\": { \"title\": \"Killed\", \"type\": \"object\", \"properties\": { \"unix_millis_request_time\": { \"title\": \"Unix Millis Request Time\", \"description\": \"The time that the cancellation request arrived\", \"type\": \"integer\" }, \"labels\": { \"title\": \"Labels\", \"description\": \"Labels to describe the kill request\", \"type\": \"array\", \"items\": { \"type\": \"string\" } } }, \"required\": [ \"unix_millis_request_time\", \"labels\" ] } } } ``` ### /tasks/{task_id}/log ``` { \"title\": \"TaskEventLog\", \"type\": \"object\", \"properties\": { \"task_id\": { \"title\": \"Task Id\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall task\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"phases\": { \"title\": \"Phases\", \"description\": \"A dictionary whose keys (property names) are the indices of a phase\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/Phases\" } } }, \"required\": [ \"task_id\" ], \"additionalProperties\": false, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] }, \"Phases\": { \"title\": \"Phases\", \"type\": \"object\", \"properties\": { \"log\": { \"title\": \"Log\", \"description\": \"Log entries related to the overall phase\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"events\": { \"title\": \"Events\", \"description\": \"A dictionary whose keys (property names) are the indices of an event in the phase\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"additionalProperties\": false } } } ``` ### /dispensers/{guid}/state ``` { \"title\": \"DispenserState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /dispensers/{guid}/health ``` { \"title\": \"DispenserHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /ingestors/{guid}/state ``` { \"title\": \"IngestorState\", \"type\": \"object\", \"properties\": { \"time\": { \"title\": \"Time\", \"default\": { \"sec\": 0, \"nanosec\": 0 }, \"allOf\": [ { \"$ref\": \"#/definitions/Time\" } ] }, \"guid\": { \"title\": \"Guid\", \"default\": \"\", \"type\": \"string\" }, \"mode\": { \"title\": \"Mode\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"request_guid_queue\": { \"title\": \"Request Guid Queue\", \"default\": [], \"type\": \"array\", \"items\": { \"type\": \"string\" } }, \"seconds_remaining\": { \"title\": \"Seconds Remaining\", \"default\": 0, \"type\": \"number\" } }, \"required\": [ \"time\", \"guid\", \"mode\", \"request_guid_queue\", \"seconds_remaining\" ], \"definitions\": { \"Time\": { \"title\": \"Time\", \"type\": \"object\", \"properties\": { \"sec\": { \"title\": \"Sec\", \"default\": 0, \"minimum\": -2147483648, \"maximum\": 2147483647, \"type\": \"integer\" }, \"nanosec\": { \"title\": \"Nanosec\", \"default\": 0, \"minimum\": 0, \"maximum\": 4294967295, \"type\": \"integer\" } }, \"required\": [ \"sec\", \"nanosec\" ] } } } ``` ### /ingestors/{guid}/health ``` { \"title\": \"IngestorHealth\", \"type\": \"object\", \"properties\": { \"health_status\": { \"title\": \"Health Status\", \"maxLength\": 255, \"nullable\": true, \"type\": \"string\" }, \"health_message\": { \"title\": \"Health Message\", \"nullable\": true, \"type\": \"string\" }, \"id_\": { \"title\": \"Id \", \"maxLength\": 255, \"type\": \"string\" } }, \"required\": [ \"health_status\", \"id_\" ], \"additionalProperties\": false } ``` ### /fleets/{name}/state ``` { \"title\": \"FleetState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"robots\": { \"title\": \"Robots\", \"description\": \"A dictionary of the states of the robots that belong to this fleet\", \"type\": \"object\", \"additionalProperties\": { \"$ref\": \"#/definitions/RobotState\" } } }, \"definitions\": { \"Status2\": { \"title\": \"Status2\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"offline\", \"shutdown\", \"idle\", \"charging\", \"working\", \"error\" ] }, \"Location2D\": { \"title\": \"Location2D\", \"type\": \"object\", \"properties\": { \"map\": { \"title\": \"Map\", \"type\": \"string\" }, \"x\": { \"title\": \"X\", \"type\": \"number\" }, \"y\": { \"title\": \"Y\", \"type\": \"number\" }, \"yaw\": { \"title\": \"Yaw\", \"type\": \"number\" } }, \"required\": [ \"map\", \"x\", \"y\", \"yaw\" ] }, \"Issue\": { \"title\": \"Issue\", \"type\": \"object\", \"properties\": { \"category\": { \"title\": \"Category\", \"description\": \"Category of the robot\'s issue\", \"type\": \"string\" }, \"detail\": { \"title\": \"Detail\", \"description\": \"Detailed information about the issue\", \"anyOf\": [ { \"type\": \"object\" }, { \"type\": \"array\", \"items\": {} }, { \"type\": \"string\" } ] } } }, \"RobotState\": { \"title\": \"RobotState\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"status\": { \"description\": \"A simple token representing the status of the robot\", \"allOf\": [ { \"$ref\": \"#/definitions/Status2\" } ] }, \"task_id\": { \"title\": \"Task Id\", \"description\": \"The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.\", \"type\": \"string\" }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"location\": { \"$ref\": \"#/definitions/Location2D\" }, \"battery\": { \"title\": \"Battery\", \"description\": \"State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)\", \"minimum\": 0.0, \"maximum\": 1.0, \"type\": \"number\" }, \"issues\": { \"title\": \"Issues\", \"description\": \"A list of issues with the robot that operators need to address\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/Issue\" } } } } } } ``` ### /fleets/{name}/log ``` { \"title\": \"FleetLog\", \"type\": \"object\", \"properties\": { \"name\": { \"title\": \"Name\", \"type\": \"string\" }, \"log\": { \"title\": \"Log\", \"description\": \"Log for the overall fleet\", \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } }, \"robots\": { \"title\": \"Robots\", \"description\": \"Dictionary of logs for the individual robots. The keys (property names) are the robot names.\", \"type\": \"object\", \"additionalProperties\": { \"type\": \"array\", \"items\": { \"$ref\": \"#/definitions/LogEntry\" } } } }, \"definitions\": { \"Tier\": { \"title\": \"Tier\", \"description\": \"An enumeration.\", \"enum\": [ \"uninitialized\", \"info\", \"warning\", \"error\" ] }, \"LogEntry\": { \"title\": \"LogEntry\", \"type\": \"object\", \"properties\": { \"seq\": { \"title\": \"Seq\", \"description\": \"Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.\", \"exclusiveMaximum\": 4294967296, \"minimum\": 0, \"type\": \"integer\" }, \"tier\": { \"description\": \"The importance level of the log entry\", \"allOf\": [ { \"$ref\": \"#/definitions/Tier\" } ] }, \"unix_millis_time\": { \"title\": \"Unix Millis Time\", \"type\": \"integer\" }, \"text\": { \"title\": \"Text\", \"description\": \"The text of the log entry\", \"type\": \"string\" } }, \"required\": [ \"seq\", \"tier\", \"unix_millis_time\", \"text\" ] } } } ``` * @summary Socket.io endpoint * @param {*} [options] Override http request option. * @throws {RequiredError} @@ -4119,10 +4257,15 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio * Available in socket.io * @summary Get Fleet Log * @param {string} name + * @param {string} [between] The period of time to fetch, in unix millis. This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis. Example: \"1000,2000\" - Fetches logs between unix millis 1000 and 2000. \"-60000\" - Fetches logs in the last minute. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFleetLogFleetsNameLogGet: async (name: string, options: any = {}): Promise => { + getFleetLogFleetsNameLogGet: async ( + name: string, + between?: string, + options: any = {}, + ): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getFleetLogFleetsNameLogGet', 'name', name); const localVarPath = `/fleets/{name}/log`.replace( @@ -4140,6 +4283,10 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (between !== undefined) { + localVarQueryParameter['between'] = between; + } + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { @@ -4266,15 +4413,18 @@ export const FleetsApiFp = function (configuration?: Configuration) { * Available in socket.io * @summary Get Fleet Log * @param {string} name + * @param {string} [between] The period of time to fetch, in unix millis. This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis. Example: \"1000,2000\" - Fetches logs between unix millis 1000 and 2000. \"-60000\" - Fetches logs in the last minute. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getFleetLogFleetsNameLogGet( name: string, + between?: string, options?: any, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getFleetLogFleetsNameLogGet( name, + between, options, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -4340,12 +4490,17 @@ export const FleetsApiFactory = function ( * Available in socket.io * @summary Get Fleet Log * @param {string} name + * @param {string} [between] The period of time to fetch, in unix millis. This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis. Example: \"1000,2000\" - Fetches logs between unix millis 1000 and 2000. \"-60000\" - Fetches logs in the last minute. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFleetLogFleetsNameLogGet(name: string, options?: any): AxiosPromise { + getFleetLogFleetsNameLogGet( + name: string, + between?: string, + options?: any, + ): AxiosPromise { return localVarFp - .getFleetLogFleetsNameLogGet(name, options) + .getFleetLogFleetsNameLogGet(name, between, options) .then((request) => request(axios, basePath)); }, /** @@ -4395,13 +4550,14 @@ export class FleetsApi extends BaseAPI { * Available in socket.io * @summary Get Fleet Log * @param {string} name + * @param {string} [between] The period of time to fetch, in unix millis. This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis. Example: \"1000,2000\" - Fetches logs between unix millis 1000 and 2000. \"-60000\" - Fetches logs in the last minute. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FleetsApi */ - public getFleetLogFleetsNameLogGet(name: string, options?: any) { + public getFleetLogFleetsNameLogGet(name: string, between?: string, options?: any) { return FleetsApiFp(this.configuration) - .getFleetLogFleetsNameLogGet(name, options) + .getFleetLogFleetsNameLogGet(name, between, options) .then((request) => request(this.axios, this.basePath)); } @@ -5116,11 +5272,13 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration * Available in socket.io * @summary Get Task Log * @param {string} taskId task_id + * @param {string} [between] The period of time to fetch, in unix millis. This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis. Example: \"1000,2000\" - Fetches logs between unix millis 1000 and 2000. \"-60000\" - Fetches logs in the last minute. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTaskLogTasksTaskIdLogGet: async ( taskId: string, + between?: string, options: any = {}, ): Promise => { // verify required parameter 'taskId' is not null or undefined @@ -5140,6 +5298,10 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; + if (between !== undefined) { + localVarQueryParameter['between'] = between; + } + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { @@ -5380,15 +5542,18 @@ export const TasksApiFp = function (configuration?: Configuration) { * Available in socket.io * @summary Get Task Log * @param {string} taskId task_id + * @param {string} [between] The period of time to fetch, in unix millis. This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis. Example: \"1000,2000\" - Fetches logs between unix millis 1000 and 2000. \"-60000\" - Fetches logs in the last minute. * @param {*} [options] Override http request option. * @throws {RequiredError} */ async getTaskLogTasksTaskIdLogGet( taskId: string, + between?: string, options?: any, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskLogTasksTaskIdLogGet( taskId, + between, options, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -5497,12 +5662,17 @@ export const TasksApiFactory = function ( * Available in socket.io * @summary Get Task Log * @param {string} taskId task_id + * @param {string} [between] The period of time to fetch, in unix millis. This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis. Example: \"1000,2000\" - Fetches logs between unix millis 1000 and 2000. \"-60000\" - Fetches logs in the last minute. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getTaskLogTasksTaskIdLogGet(taskId: string, options?: any): AxiosPromise { + getTaskLogTasksTaskIdLogGet( + taskId: string, + between?: string, + options?: any, + ): AxiosPromise { return localVarFp - .getTaskLogTasksTaskIdLogGet(taskId, options) + .getTaskLogTasksTaskIdLogGet(taskId, between, options) .then((request) => request(axios, basePath)); }, /** @@ -5597,13 +5767,14 @@ export class TasksApi extends BaseAPI { * Available in socket.io * @summary Get Task Log * @param {string} taskId task_id + * @param {string} [between] The period of time to fetch, in unix millis. This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis. Example: \"1000,2000\" - Fetches logs between unix millis 1000 and 2000. \"-60000\" - Fetches logs in the last minute. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TasksApi */ - public getTaskLogTasksTaskIdLogGet(taskId: string, options?: any) { + public getTaskLogTasksTaskIdLogGet(taskId: string, between?: string, options?: any) { return TasksApiFp(this.configuration) - .getTaskLogTasksTaskIdLogGet(taskId, options) + .getTaskLogTasksTaskIdLogGet(taskId, between, options) .then((request) => request(this.axios, this.basePath)); } diff --git a/packages/api-client/lib/version.ts b/packages/api-client/lib/version.ts index 226785175..b3a66384f 100644 --- a/packages/api-client/lib/version.ts +++ b/packages/api-client/lib/version.ts @@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models'; export const version = { rmfModels: rmfModelVer, - rmfServer: '1333704b68016a5bc28e9395ba42e2b123fe3424', + rmfServer: '9e6287bacb8cd75693910a49ab012b593703c005', openapiGenerator: '5.2.1', }; From c5709dd6aa37524ae19fb7a18ba1c7a6ef853a6b Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 10 Jan 2022 02:06:02 +0000 Subject: [PATCH 23/79] build deps and start rmf Signed-off-by: Teo Koon Peng --- packages/dashboard/package.json | 2 +- packages/dashboard/src/components/tasks/task-logs.tsx | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/packages/dashboard/package.json b/packages/dashboard/package.json index 89ff1694b..09722166b 100644 --- a/packages/dashboard/package.json +++ b/packages/dashboard/package.json @@ -4,7 +4,7 @@ "private": true, "scripts": { "analyze": "source-map-explorer 'build/static/js/*.js'", - "start": "concurrently npm:start:rmf-server npm:start:react", + "start": "../../scripts/nws.sh build -d && concurrently npm:start:rmf-server npm:start:rmf npm:start:react", "start:clinic": "RMF_DASHBOARD_DEMO_MAP=clinic.launch.xml npm start", "start:airport": "RMF_DASHBOARD_DEMO_MAP=airport_terminal.launch.xml npm start", "start:react": "react-scripts start", diff --git a/packages/dashboard/src/components/tasks/task-logs.tsx b/packages/dashboard/src/components/tasks/task-logs.tsx index cb8f9749b..7f9c49ce5 100644 --- a/packages/dashboard/src/components/tasks/task-logs.tsx +++ b/packages/dashboard/src/components/tasks/task-logs.tsx @@ -1,7 +1,7 @@ -import React from 'react'; import { Divider, Grid, Paper, PaperProps, styled, Typography, useTheme } from '@mui/material'; +import { TaskEventLog } from 'api-client'; import { format } from 'date-fns'; -import { TaskEventLog, TaskState } from 'api-client'; +import React from 'react'; const prefix = 'task-logs'; const classes = { From 1f04aa37803af5b4af6405088dcdcd69e3b175a0 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 10 Jan 2022 02:38:41 +0000 Subject: [PATCH 24/79] return helpful error when request has invalid query Signed-off-by: Teo Koon Peng --- .../api-server/api_server/repositories/tasks.py | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/packages/api-server/api_server/repositories/tasks.py b/packages/api-server/api_server/repositories/tasks.py index fda24c86f..76d376ca4 100644 --- a/packages/api-server/api_server/repositories/tasks.py +++ b/packages/api-server/api_server/repositories/tasks.py @@ -1,6 +1,7 @@ from typing import List, Optional, Tuple, cast -from fastapi import Depends +from fastapi import Depends, HTTPException +from tortoise.exceptions import FieldError from tortoise.query_utils import Prefetch from tortoise.queryset import QuerySet @@ -18,11 +19,14 @@ def __init__(self, user: User): async def query_task_states( self, query: QuerySet[DbTaskState], pagination: Optional[Pagination] = None ) -> List[TaskState]: - if pagination: - query = add_pagination(query, pagination) - # TODO: enforce with authz - results = await query.values_list("data", flat=True) - return [TaskState(**r) for r in results] + try: + if pagination: + query = add_pagination(query, pagination) + # TODO: enforce with authz + results = await query.values_list("data", flat=True) + return [TaskState(**r) for r in results] + except FieldError as e: + raise HTTPException(422, str(e)) async def get_task_state(self, task_id: str) -> Optional[TaskState]: # TODO: enforce with authz From 0b94ab92d637a403a2b07a5e79783ed589364a4c Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 10 Jan 2022 03:21:34 +0000 Subject: [PATCH 25/79] fix missing imports and add some logging Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/gateway.py | 2 -- packages/api-server/api_server/repositories/tasks.py | 2 +- packages/api-server/api_server/rmf_gateway_app.py | 6 ++++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/packages/api-server/api_server/gateway.py b/packages/api-server/api_server/gateway.py index 4c17fd3e3..d855e85af 100644 --- a/packages/api-server/api_server/gateway.py +++ b/packages/api-server/api_server/gateway.py @@ -23,7 +23,6 @@ from rmf_lift_msgs.msg import LiftRequest as RmfLiftRequest from rmf_lift_msgs.msg import LiftState as RmfLiftState from rmf_task_msgs.srv import CancelTask as RmfCancelTask -from rmf_task_msgs.srv import GetTaskList as RmfGetTaskList from rmf_task_msgs.srv import SubmitTask as RmfSubmitTask from rosidl_runtime_py.convert import message_to_ordereddict @@ -73,7 +72,6 @@ def __init__( RmfLiftRequest, "adapter_lift_requests", 10 ) self._submit_task_srv = ros_node.create_client(RmfSubmitTask, "submit_task") - self.get_tasks_srv = ros_node.create_client(RmfGetTaskList, "get_tasks") self._cancel_task_srv = ros_node.create_client(RmfCancelTask, "cancel_task") self.static_files = static_files diff --git a/packages/api-server/api_server/repositories/tasks.py b/packages/api-server/api_server/repositories/tasks.py index 76d376ca4..0c203c219 100644 --- a/packages/api-server/api_server/repositories/tasks.py +++ b/packages/api-server/api_server/repositories/tasks.py @@ -26,7 +26,7 @@ async def query_task_states( results = await query.values_list("data", flat=True) return [TaskState(**r) for r in results] except FieldError as e: - raise HTTPException(422, str(e)) + raise HTTPException(422, str(e)) from e async def get_task_state(self, task_id: str) -> Optional[TaskState]: # TODO: enforce with authz diff --git a/packages/api-server/api_server/rmf_gateway_app.py b/packages/api-server/api_server/rmf_gateway_app.py index 8779bc730..caee0b022 100644 --- a/packages/api-server/api_server/rmf_gateway_app.py +++ b/packages/api-server/api_server/rmf_gateway_app.py @@ -1,19 +1,21 @@ # NOTE: This will eventually replace `gateway.py`` -import sys from typing import Any, Dict from fastapi import FastAPI, WebSocket, WebSocketDisconnect from . import models as mdl +from .logger import logger as base_logger from .rmf_io import fleet_events, task_events app = FastAPI() +logger = base_logger.getChild("RmfGatewayApp") async def process_msg(msg: Dict[str, Any]) -> None: payload_type: str = msg["type"] if not isinstance(payload_type, str): - print("'type' must be a string", file=sys.stderr) + logger.error("'type' must be a string") + logger.info(f"received message of type '{payload_type}'") if payload_type == "task_state_update": task_state = mdl.TaskState(**msg["data"]) From e4a5c7f73f0b3528384f1d4b373e8147f334f425 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 10 Jan 2022 05:52:14 +0000 Subject: [PATCH 26/79] dashboard build success Signed-off-by: Teo Koon Peng --- packages/api-client/lib/index.ts | 5 +++ packages/api-server/api_server/logger.py | 1 - .../src/components/tasks/task-page.tsx | 41 +++++++++---------- 3 files changed, 25 insertions(+), 22 deletions(-) diff --git a/packages/api-client/lib/index.ts b/packages/api-client/lib/index.ts index a9162c4c9..edcdccc40 100644 --- a/packages/api-client/lib/index.ts +++ b/packages/api-client/lib/index.ts @@ -11,6 +11,7 @@ import { IngestorState, LiftHealth, LiftState, + TaskState, } from './openapi'; const debug = Debug('rmf-client'); @@ -95,6 +96,10 @@ export class SioClient { subscribeFleetState(name: string, listener: Listener): Listener { return this.subscribe(`/fleets/${name}/state`, listener); } + + subscribeTaskState(taskId: string, listener: Listener): Listener { + return this.subscribe(`/tasks/${taskId}/state`, listener); + } } export * from './openapi'; diff --git a/packages/api-server/api_server/logger.py b/packages/api-server/api_server/logger.py index 6dd1d6d87..ec358ac8c 100644 --- a/packages/api-server/api_server/logger.py +++ b/packages/api-server/api_server/logger.py @@ -11,7 +11,6 @@ handler.setFormatter(logging.Formatter(logging.BASIC_FORMAT)) logger.addHandler(handler) logger.setLevel(app_config.log_level) -logger.name = "app" def format_exception(exception: Exception): diff --git a/packages/dashboard/src/components/tasks/task-page.tsx b/packages/dashboard/src/components/tasks/task-page.tsx index f8b240603..ada475879 100644 --- a/packages/dashboard/src/components/tasks/task-page.tsx +++ b/packages/dashboard/src/components/tasks/task-page.tsx @@ -17,12 +17,11 @@ const StyledTaskPage = styled((props: TaskPanelProps) => ([]); - const [updatedSummaries, setUpdatedSummaries] = React.useState>({}); - // const [autoRefreshEnabled, setAutoRefreshEnabled] = React.useState(true); + const [updatedSummaries, setUpdatedStates] = React.useState>({}); + const [autoRefreshEnabled, setAutoRefreshEnabled] = React.useState(true); const [page, setPage] = React.useState(0); const [hasMore, setHasMore] = React.useState(true); const places = React.useContext(PlacesContext); @@ -42,9 +41,9 @@ export function TaskPage() { undefined, undefined, undefined, - undefined, - undefined, - undefined, + 11, + page * 10, + '-start_time', undefined, ); const results = resp.data as TaskState[]; @@ -54,20 +53,20 @@ export function TaskPage() { [tasksApi], ); - // React.useEffect(() => { - // if (!autoRefreshEnabled || !sioClient) return; - // const subs = fetchedTasks.map((t) => - // sioClient.su(t.booking.id, (newSummary) => - // setUpdatedSummaries((prev) => ({ - // ...prev, - // [newSummary.task_id]: newSummary, - // })), - // ), - // ); - // return () => { - // subs.forEach((s) => sioClient.unsubscribe(s)); - // }; - // }, [autoRefreshEnabled, sioClient, fetchedTasks]); + React.useEffect(() => { + if (!autoRefreshEnabled || !sioClient) return; + const subs = fetchedTasks.map((t) => + sioClient.subscribeTaskState(t.booking.id, (newState) => + setUpdatedStates((prev) => ({ + ...prev, + [newState.booking.id]: newState, + })), + ), + ); + return () => { + subs.forEach((s) => sioClient.unsubscribe(s)); + }; + }, [autoRefreshEnabled, sioClient, fetchedTasks]); const handleRefresh = React.useCallback['onRefresh']>(async () => { fetchTasks(page); @@ -126,7 +125,7 @@ export function TaskPage() { submitTasks={submitTasks} cancelTask={cancelTask} onRefresh={handleRefresh} - // onAutoRefresh={setAutoRefreshEnabled} + onAutoRefresh={setAutoRefreshEnabled} /> ); } From 70a597085a9028daf09c3d8f883954c88c5ffbc7 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Fri, 14 Jan 2022 02:46:57 +0000 Subject: [PATCH 27/79] support task dispatch, cancellation, discovery etc Signed-off-by: Teo Koon Peng --- .../api-server/api_server/fast_io/__init__.py | 2 +- .../api-server/api_server/models/__init__.py | 22 +++ packages/api-server/api_server/response.py | 5 + .../api-server/api_server/rmf_io/__init__.py | 1 + .../api_server/rmf_io/rmf_service.py | 32 ++-- .../api_server/rmf_io/test_rmf_service.py | 6 +- .../api_server/routes/tasks/tasks.py | 104 +++++++++---- .../api_server/routes/tasks/test_tasks.py | 143 +++++++++++++++++- .../api_server/test/test_fixtures.py | 1 + .../api-server/api_server/test/test_server.py | 4 +- packages/api-server/generate-models.sh | 4 +- 11 files changed, 266 insertions(+), 58 deletions(-) create mode 100644 packages/api-server/api_server/response.py diff --git a/packages/api-server/api_server/fast_io/__init__.py b/packages/api-server/api_server/fast_io/__init__.py index 5ae7da1c3..e9fc51c3f 100644 --- a/packages/api-server/api_server/fast_io/__init__.py +++ b/packages/api-server/api_server/fast_io/__init__.py @@ -139,7 +139,7 @@ def encode(self): and isinstance(self.data[1], pydantic.BaseModel) ): pkt_data = FastIOPacket.PacketData.construct(__root__=self.data) - return str(self.packet_type) + pkt_data.json() + return str(self.packet_type) + pkt_data.json(exclude_none=True) return super().encode() diff --git a/packages/api-server/api_server/models/__init__.py b/packages/api-server/api_server/models/__init__.py index 172b6a699..5c30f96df 100644 --- a/packages/api-server/api_server/models/__init__.py +++ b/packages/api-server/api_server/models/__init__.py @@ -7,9 +7,31 @@ from .ingestors import * from .lifts import * from .pagination import * +from .rmf_api.activity_discovery_request import ActivityDiscoveryRequest +from .rmf_api.activity_discovery_response import ActivityDiscovery from .rmf_api.cancel_task_request import CancelTaskRequest from .rmf_api.cancel_task_response import TaskCancelResponse +from .rmf_api.dispatch_task_request import DispatchTaskRequest +from .rmf_api.dispatch_task_response import TaskDispatchResponse +from .rmf_api.fleet_log_request import FleetLogRequest +from .rmf_api.fleet_log_response import FleetLogResponse +from .rmf_api.interrupt_task_request import TaskInterruptionRequest +from .rmf_api.interrupt_task_response import TaskInterruptionResponse +from .rmf_api.kill_task_request import TaskKillRequest +from .rmf_api.kill_task_response import TaskKillResponse from .rmf_api.log_entry import LogEntry, Tier +from .rmf_api.resume_task_request import TaskResumeRequest +from .rmf_api.resume_task_response import TaskResumeResponse +from .rmf_api.rewind_task_request import TaskRewindRequest +from .rmf_api.rewind_task_response import TaskRewindResponse +from .rmf_api.skip_phase_request import TaskPhaseSkipRequest +from .rmf_api.skip_phase_response import SkipPhaseResponse +from .rmf_api.task_discovery_request import TaskDiscoveryRequest +from .rmf_api.task_discovery_response import TaskDiscovery +from .rmf_api.task_log_request import TaskLogRequest +from .rmf_api.task_log_response import TaskLogResponse from .rmf_api.task_request import TaskRequest +from .rmf_api.undo_skip_phase_request import UndoPhaseSkipRequest +from .rmf_api.undo_skip_phase_response import UndoPhaseSkipResponse from .tasks import TaskEventLog, TaskState from .user import * diff --git a/packages/api-server/api_server/response.py b/packages/api-server/api_server/response.py new file mode 100644 index 000000000..1fb44dc2d --- /dev/null +++ b/packages/api-server/api_server/response.py @@ -0,0 +1,5 @@ +from fastapi.responses import PlainTextResponse + + +class RawJSONResponse(PlainTextResponse): + media_type = "application/json" diff --git a/packages/api-server/api_server/rmf_io/__init__.py b/packages/api-server/api_server/rmf_io/__init__.py index 621c0628f..92b80f314 100644 --- a/packages/api-server/api_server/rmf_io/__init__.py +++ b/packages/api-server/api_server/rmf_io/__init__.py @@ -1,4 +1,5 @@ from .book_keeper import RmfBookKeeper, RmfBookKeeperEvents from .events import RmfEvents, TaskEvents, fleet_events, rmf_events, task_events from .health_watchdog import HealthWatchdog +from .rmf_service import RmfService, tasks_service from .topics import topics diff --git a/packages/api-server/api_server/rmf_io/rmf_service.py b/packages/api-server/api_server/rmf_io/rmf_service.py index 396662413..2b78b52a9 100644 --- a/packages/api-server/api_server/rmf_io/rmf_service.py +++ b/packages/api-server/api_server/rmf_io/rmf_service.py @@ -1,13 +1,16 @@ import asyncio from asyncio import Future from typing import Dict +from uuid import uuid4 import rclpy import rclpy.node import rclpy.qos +from fastapi import HTTPException from rmf_task_msgs.msg import ApiRequest, ApiResponse from api_server.logger import logger +from api_server.ros import ros_node as g_ros_node class RmfService: @@ -20,17 +23,15 @@ class RmfService: request ids which they published and drop and unknown and duplicated response ids. """ - API_REQUEST_TOPIC = "api_request" - API_RESPONSE_TOPIC = "api_response" - - def __init__(self, ros_node: rclpy.node.Node): + def __init__( + self, ros_node: rclpy.node.Node, request_topic: str, response_topic: str + ): self.ros_node = ros_node self._logger = logger.getChild(self.__class__.__name__) - self._id_counter = 0 self._requests: Dict[str, Future] = {} self._api_pub = self.ros_node.create_publisher( ApiRequest, - self.API_REQUEST_TOPIC, + request_topic, rclpy.qos.QoSProfile( depth=10, history=rclpy.qos.HistoryPolicy.KEEP_LAST, @@ -40,7 +41,7 @@ def __init__(self, ros_node: rclpy.node.Node): ) self._api_sub = self.ros_node.create_subscription( ApiResponse, - self.API_RESPONSE_TOPIC, + response_topic, self._handle_response, rclpy.qos.QoSProfile( depth=10, @@ -57,16 +58,18 @@ def destroy(self): self._api_sub.destroy() self._api_pub.destroy() - async def call(self, payload: str, timeout=1) -> str: - req_id = str(self._id_counter) - self._id_counter += 1 + async def call(self, payload: str, timeout: float = 1) -> str: + req_id = str(uuid4()) msg = ApiRequest(request_id=req_id, json_msg=payload) fut = Future() self._requests[req_id] = fut self._api_pub.publish(msg) - resp = await asyncio.wait_for(fut, timeout) - del self._requests[req_id] - return resp + try: + return await asyncio.wait_for(fut, timeout) + except asyncio.TimeoutError as e: + raise HTTPException(500, "rmf service timed out") from e + finally: + del self._requests[req_id] def _handle_response(self, msg: ApiResponse): fut = self._requests.get(msg.request_id) @@ -76,3 +79,6 @@ def _handle_response(self, msg: ApiResponse): ) return fut.set_result(msg.json_msg) + + +tasks_service = RmfService(g_ros_node, "task_api_requests", "task_api_responses") diff --git a/packages/api-server/api_server/rmf_io/test_rmf_service.py b/packages/api-server/api_server/rmf_io/test_rmf_service.py index c998471bc..579eadf91 100644 --- a/packages/api-server/api_server/rmf_io/test_rmf_service.py +++ b/packages/api-server/api_server/rmf_io/test_rmf_service.py @@ -48,7 +48,7 @@ def client(): def server(): pub = cls.server_node.create_publisher( ApiResponse, - RmfService.API_RESPONSE_TOPIC, + "test_response", rclpy.qos.QoSProfile( depth=10, history=rclpy.qos.HistoryPolicy.KEEP_LAST, @@ -64,7 +64,7 @@ def handle_resp(msg: ApiRequest): cls.server_node.create_subscription( ApiRequest, - RmfService.API_REQUEST_TOPIC, + "test_request", handle_resp, rclpy.qos.QoSProfile( depth=10, @@ -88,7 +88,7 @@ def handle_resp(msg: ApiRequest): while cls.client_node.get_name() not in cls.server_node.get_node_names(): time.sleep(0.1) - cls.rmf_service = RmfService(cls.client_node) + cls.rmf_service = RmfService(cls.client_node, "test_request", "test_response") @classmethod def tearDownClass(cls) -> None: diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index 47306cbe1..8e8d1ea34 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -5,26 +5,18 @@ from rx import operators as rxops from rx.subject.replaysubject import ReplaySubject -from api_server.authenticator import user_dep +from api_server import models as mdl from api_server.dependencies import between_query, pagination_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest -from api_server.models import ( - CancelTaskRequest, - Pagination, - TaskCancelResponse, - TaskRequest, - TaskState, - User, -) -from api_server.models.tasks import TaskEventLog from api_server.models.tortoise_models import TaskState as DbTaskState from api_server.repositories import TaskRepository, task_repo_dep -from api_server.rmf_io import task_events +from api_server.response import RawJSONResponse +from api_server.rmf_io import task_events, tasks_service router = FastIORouter(tags=["Tasks"]) -@router.get("", response_model=List[TaskState]) +@router.get("", response_model=List[mdl.TaskState]) async def query_task_states( task_repo: TaskRepository = Depends(task_repo_dep), task_id: Optional[str] = Query( @@ -35,7 +27,7 @@ async def query_task_states( ), start_time: Optional[datetime] = None, finish_time: Optional[datetime] = None, - pagination: Pagination = Depends(pagination_query), + pagination: mdl.Pagination = Depends(pagination_query), ): filters = {} if task_id is not None: @@ -50,7 +42,7 @@ async def query_task_states( return await task_repo.query_task_states(DbTaskState.filter(**filters), pagination) -@router.get("/{task_id}/state", response_model=TaskState) +@router.get("/{task_id}/state", response_model=mdl.TaskState) async def get_task_state( task_repo: TaskRepository = Depends(task_repo_dep), task_id: str = Path(..., description="task_id"), @@ -64,7 +56,7 @@ async def get_task_state( return result -@router.sub("/{task_id}/state", response_model=TaskState) +@router.sub("/{task_id}/state", response_model=mdl.TaskState) async def sub_task_state(req: SubscriptionRequest, task_id: str): user = sio_user(req) task_repo = TaskRepository(user) @@ -73,12 +65,12 @@ async def sub_task_state(req: SubscriptionRequest, task_id: str): if current_state: sub.on_next(current_state) task_events.task_states.pipe( - rxops.filter(lambda x: cast(TaskState, x).booking.id == task_id) + rxops.filter(lambda x: cast(mdl.TaskState, x).booking.id == task_id) ).subscribe(sub) return sub -@router.get("/{task_id}/log", response_model=TaskEventLog) +@router.get("/{task_id}/log", response_model=mdl.TaskEventLog) async def get_task_log( task_repo: TaskRepository = Depends(task_repo_dep), task_id: str = Path(..., description="task_id"), @@ -94,26 +86,78 @@ async def get_task_log( return result -@router.sub("/{task_id}/log", response_model=TaskEventLog) +@router.sub("/{task_id}/log", response_model=mdl.TaskEventLog) async def sub_task_log(_req: SubscriptionRequest, task_id: str): return task_events.task_event_logs.pipe( - rxops.filter(lambda x: cast(TaskEventLog, x).task_id == task_id) + rxops.filter(lambda x: cast(mdl.TaskEventLog, x).task_id == task_id) ) -@router.post("/task_request") -async def post_task_request( - user: User = Depends(user_dep), - task_request: TaskRequest = Body(...), +@router.post("/activity_discovery", response_model=mdl.ActivityDiscovery) +async def post_activity_discovery( + request: mdl.ActivityDiscoveryRequest = Body(...), ): - # TODO: forward to the internal app - raise HTTPException(status_code=501) + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) -@router.post("/cancel_task", response_model=TaskCancelResponse) +@router.post("/cancel_task", response_model=mdl.TaskCancelResponse) async def post_cancel_task( - user: User = Depends(user_dep), - cancel_request: CancelTaskRequest = Body(...), + request: mdl.CancelTaskRequest = Body(...), +): + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) + + +@router.post("/dispatch_task", response_model=mdl.TaskDispatchResponse) +async def post_task_request( + request: mdl.DispatchTaskRequest = Body(...), +): + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) + + +@router.post("/interrupt_task", response_model=mdl.TaskInterruptionResponse) +async def post_interrupt_task( + request: mdl.TaskInterruptionRequest = Body(...), +): + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) + + +@router.post("/kill_task", response_model=mdl.TaskKillResponse) +async def post_kill_task( + request: mdl.TaskKillRequest = Body(...), +): + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) + + +@router.post("/resume_task", response_model=mdl.TaskResumeResponse) +async def post_resume_task( + request: mdl.TaskResumeRequest = Body(...), +): + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) + + +@router.post("/rewind_task", response_model=mdl.TaskRewindResponse) +async def post_rewind_task( + request: mdl.TaskRewindRequest = Body(...), +): + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) + + +@router.post("/skip_phase", response_model=mdl.SkipPhaseResponse) +async def post_skip_phase( + request: mdl.TaskPhaseSkipRequest = Body(...), +): + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) + + +@router.post("/task_discovery", response_model=mdl.TaskDiscovery) +async def post_task_discovery( + request: mdl.TaskDiscoveryRequest = Body(...), +): + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) + + +@router.post("/undo_skip_phase", response_model=mdl.UndoPhaseSkipResponse) +async def post_undo_skip_phase( + request: mdl.UndoPhaseSkipRequest = Body(...), ): - # TODO: forward to the internal app - raise HTTPException(status_code=501) + return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) diff --git a/packages/api-server/api_server/routes/tasks/test_tasks.py b/packages/api-server/api_server/routes/tasks/test_tasks.py index 187f07809..6a4fca352 100644 --- a/packages/api-server/api_server/routes/tasks/test_tasks.py +++ b/packages/api-server/api_server/routes/tasks/test_tasks.py @@ -1,7 +1,8 @@ +from unittest.mock import patch from uuid import uuid4 -from api_server.models import TaskEventLog, Tier -from api_server.rmf_io import task_events +from api_server import models as mdl +from api_server.rmf_io import task_events, tasks_service from api_server.test import AppFixture, make_task_log, make_task_state @@ -24,7 +25,10 @@ async def prepare_db(): def test_get_task_state(self): resp = self.session.get(f"/tasks/{self.task_states[0].booking.id}/state") self.assertEqual(200, resp.status_code) - self.assertEqual(self.task_states[0].booking.id, resp.json()["booking"]["id"]) + self.assertEqual( + self.task_states[0].booking.id, + resp.json()["booking"]["id"], + ) def test_query_task_states(self): resp = self.session.get(f"/tasks?task_id={self.task_states[0].booking.id}") @@ -43,7 +47,7 @@ def test_get_task_log(self): f"/tasks/{self.task_logs[0].task_id}/log?between=0,1636388414500" ) self.assertEqual(200, resp.status_code) - logs = TaskEventLog(**resp.json()) + logs = mdl.TaskEventLog(**resp.json()) self.assertEqual(self.task_logs[0].task_id, logs.task_id) # check task log @@ -53,7 +57,7 @@ def test_get_task_log(self): self.assertEqual(1, len(logs.log)) log = logs.log[0] self.assertEqual(0, log.seq) - self.assertEqual(Tier.info, log.tier) + self.assertEqual(mdl.Tier.info, log.tier) self.assertEqual(1636388410000, log.unix_millis_time) self.assertEqual("Beginning task", log.text) @@ -74,7 +78,7 @@ def test_get_task_log(self): self.assertEqual(1, len(phase1_log)) log = phase1_log[0] self.assertEqual(0, log.seq) - self.assertEqual(Tier.info, log.tier) + self.assertEqual(mdl.Tier.info, log.tier) self.assertEqual(1636388410000, log.unix_millis_time) self.assertEqual("Beginning phase", log.text) @@ -94,7 +98,7 @@ def test_get_task_log(self): ) # check only logs in the period is returned log = phase1_events["1"][0] self.assertEqual(0, log.seq) - self.assertEqual(Tier.info, log.tier) + self.assertEqual(mdl.Tier.info, log.tier) self.assertEqual(1636388409995, log.unix_millis_time) self.assertEqual( "Generating plan to get from [place:parking_03] to [place:kitchen]", @@ -113,3 +117,128 @@ def test_sub_task_log(self): task_events.task_event_logs.on_next(task_logs) result = fut.result(1) self.assertEqual(task_id, result["task_id"]) + + def test_activity_discovery(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.ActivityDiscovery().json(exclude_none=True) + resp = self.session.post( + "/tasks/activity_discovery", + data=mdl.ActivityDiscoveryRequest( + type="activitiy_discovery_request" + ).json(exclude_none=True), + ) + self.assertEqual(200, resp.status_code, resp.content) + + def test_cancel_task(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.TaskCancelResponse.parse_obj( + {"success": True} + ).json(exclude_none=True) + resp = self.session.post( + "/tasks/activity_discovery", + data=mdl.ActivityDiscoveryRequest( + type="activitiy_discovery_request" + ).json(exclude_none=True), + ) + self.assertEqual(200, resp.status_code, resp.content) + + def test_dispatch_task(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.TaskDispatchResponse.parse_obj( + {"success": True} + ).json(exclude_none=True) + resp = self.session.post( + "/tasks/dispatch_task", + data=mdl.DispatchTaskRequest( + type="dispatch_task_request", + request=mdl.TaskRequest(category="test", description="description"), # type: ignore + ).json(exclude_none=True), + ) + self.assertEqual(200, resp.status_code, resp.content) + + def test_interrupt_task(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.TaskInterruptionResponse.parse_obj( + {"success": True, "token": "token"} + ).json(exclude_none=True) + resp = self.session.post( + "/tasks/interrupt_task", + data=mdl.TaskInterruptionRequest( # type: ignore + type="interrupt_task_request", task_id="task_id" + ).json(exclude_none=True), + ) + self.assertEqual(200, resp.status_code, resp.content) + + def test_kill_task(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.TaskKillResponse.parse_obj({"success": True}).json( + exclude_none=True + ) + resp = self.session.post( + "/tasks/kill_task", + data=mdl.TaskKillRequest( # type: ignore + type="kill_task_request", task_id="task_id" + ).json(exclude_none=True), + ) + self.assertEqual(200, resp.status_code, resp.content) + + def test_resume_task(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.TaskResumeResponse.parse_obj( + {"success": True} + ).json(exclude_none=True) + resp = self.session.post( + "/tasks/resume_task", + data=mdl.TaskResumeRequest().json(exclude_none=True), # type: ignore + ) + self.assertEqual(200, resp.status_code, resp.content) + + def test_rewind_task(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.TaskRewindResponse.parse_obj( + {"success": True} + ).json(exclude_none=True) + resp = self.session.post( + "/tasks/rewind_task", + data=mdl.TaskRewindRequest( + type="rewind_task_request", task_id="task_id", phase_id=0 + ).json( + exclude_none=True + ), # type: ignore + ) + self.assertEqual(200, resp.status_code, resp.content) + + def test_skip_phase(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.SkipPhaseResponse.parse_obj( + {"success": True, "token": "token"} + ).json(exclude_none=True) + resp = self.session.post( + "/tasks/skip_phase", + data=mdl.TaskPhaseSkipRequest( # type: ignore + type="skip_phase_request", task_id="task_id", phase_id=0 + ).json(exclude_none=True), + ) + self.assertEqual(200, resp.status_code, resp.content) + + def test_task_discovery(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.TaskDiscovery().json(exclude_none=True) # type: ignore + resp = self.session.post( + "/tasks/task_discovery", + data=mdl.TaskDiscoveryRequest(type="task_discovery_request").json( + exclude_none=True + ), + ) + self.assertEqual(200, resp.status_code, resp.content) + + def test_undo_skip_phase(self): + with patch.object(tasks_service, "call") as mock: + mock.return_value = mdl.UndoPhaseSkipResponse.parse_obj( + {"success": True} + ).json(exclude_none=True) + resp = self.session.post( + "/tasks/undo_skip_phase", + data=mdl.UndoPhaseSkipRequest(type="undo_phase_skip_request").json(exclude_none=True), # type: ignore + ) + self.assertEqual(200, resp.status_code, resp.content) diff --git a/packages/api-server/api_server/test/test_fixtures.py b/packages/api-server/api_server/test/test_fixtures.py index ac51ba6d0..81651956d 100644 --- a/packages/api-server/api_server/test/test_fixtures.py +++ b/packages/api-server/api_server/test/test_fixtures.py @@ -4,6 +4,7 @@ import os.path import time import unittest +import unittest.mock from concurrent.futures import Future from typing import Any, Awaitable, Callable, List, Optional, TypeVar, Union, cast from uuid import uuid4 diff --git a/packages/api-server/api_server/test/test_server.py b/packages/api-server/api_server/test/test_server.py index 99b7a3b1b..e061fe496 100644 --- a/packages/api-server/api_server/test/test_server.py +++ b/packages/api-server/api_server/test/test_server.py @@ -18,8 +18,8 @@ def __init__(self): def on_startup(): self._ready.release() - app: FastAPI = srv.config.app - app.add_event_handler("startup", on_startup) + srv_app: FastAPI = srv.config.app + srv_app.add_event_handler("startup", on_startup) self.loop: asyncio.AbstractEventLoop diff --git a/packages/api-server/generate-models.sh b/packages/api-server/generate-models.sh index fa8e14e75..b0630afd6 100755 --- a/packages/api-server/generate-models.sh +++ b/packages/api-server/generate-models.sh @@ -60,7 +60,7 @@ EOF pipenv run isort api_server/models/ros_pydantic pipenv run black api_server/models/ros_pydantic -# # generate rmf api models from json schemas +# generate rmf api models from json schemas output='api_server/models/rmf_api' rm -rf "$output" mkdir -p "$output" @@ -69,7 +69,7 @@ if [[ ! -d .venv_local/lib ]]; then bash -c ". .venv_local/bin/activate && pip3 install wheel && pip3 install 'datamodel-code-generator~=0.11.15'" fi rm -rf api_server/models/rmf_api -bash -c ". .venv_local/bin/activate && datamodel-codegen --disable-timestamp --input-file-type jsonschema --input build/rmf_api_msgs/rmf_api_msgs/schemas --output \"$output\"" +bash -c ". .venv_local/bin/activate && datamodel-codegen --disable-timestamp --input-file-type jsonschema --enum-field-as-literal one --input build/rmf_api_msgs/rmf_api_msgs/schemas --output \"$output\"" cat << EOF > "$output/version.py" # THIS FILE IS GENERATED version = { From d3f5f972f0feed7878f39a51f1a2fe2948cb1e25 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Fri, 14 Jan 2022 04:44:32 +0000 Subject: [PATCH 28/79] add debug printouts Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/rmf_gateway_app.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/api-server/api_server/rmf_gateway_app.py b/packages/api-server/api_server/rmf_gateway_app.py index caee0b022..ed4224fbd 100644 --- a/packages/api-server/api_server/rmf_gateway_app.py +++ b/packages/api-server/api_server/rmf_gateway_app.py @@ -14,8 +14,10 @@ async def process_msg(msg: Dict[str, Any]) -> None: payload_type: str = msg["type"] if not isinstance(payload_type, str): - logger.error("'type' must be a string") + logger.error("error processing message, 'type' must be a string") + return logger.info(f"received message of type '{payload_type}'") + logger.debug(msg) if payload_type == "task_state_update": task_state = mdl.TaskState(**msg["data"]) From b964fea398406bfbfe0c2bc3027009e147e9b09d Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Fri, 14 Jan 2022 08:34:23 +0000 Subject: [PATCH 29/79] use ros clock Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/clock.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/packages/api-server/api_server/clock.py b/packages/api-server/api_server/clock.py index 398b63c28..e96e9c883 100644 --- a/packages/api-server/api_server/clock.py +++ b/packages/api-server/api_server/clock.py @@ -1,8 +1,9 @@ -import time +from .ros import ros_node def now() -> int: """ Return current unix time in millis """ - return int(time.time() * 1000) + ros_time = ros_node.get_clock().now() + return ros_time.nanoseconds // 1000000 From d974b40800207099b82e655120b86d0300373cf3 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Tue, 18 Jan 2022 09:26:02 +0800 Subject: [PATCH 30/79] build: tasksv2/better dev defaults (#568) * add ros_args options; default start with disk sqlite and use_sim_time Signed-off-by: Teo Koon Peng * RMF_SERVER_USE_SIM_TIME takes precedence over config Signed-off-by: Teo Koon Peng --- packages/api-server/.gitignore | 2 +- packages/api-server/api_server/app_config.py | 3 ++- packages/api-server/api_server/default_config.py | 4 ++++ packages/api-server/api_server/ros.py | 7 +++++-- packages/api-server/package.json | 3 ++- packages/api-server/psql_local_config.py | 8 ++------ packages/api-server/sqlite_local_config.py | 14 ++++++++++++++ 7 files changed, 30 insertions(+), 11 deletions(-) create mode 100644 packages/api-server/sqlite_local_config.py diff --git a/packages/api-server/.gitignore b/packages/api-server/.gitignore index eb202355f..0964673ef 100644 --- a/packages/api-server/.gitignore +++ b/packages/api-server/.gitignore @@ -1,8 +1,8 @@ /api_server.egg-info -/static /test_artifacts/ /.coverage /.coverage.* /htmlcov/ /build/ /dist/ +/run/ diff --git a/packages/api-server/api_server/app_config.py b/packages/api-server/api_server/app_config.py index 0eca3abed..0e3f9401b 100644 --- a/packages/api-server/api_server/app_config.py +++ b/packages/api-server/api_server/app_config.py @@ -3,7 +3,7 @@ import urllib.parse from dataclasses import dataclass from importlib.abc import Loader -from typing import Any, Optional, cast +from typing import Any, List, Optional, cast @dataclass @@ -19,6 +19,7 @@ class AppConfig: oidc_url: Optional[str] aud: str iss: Optional[str] + ros_args: List[str] def __post_init__(self): self.public_url = urllib.parse.urlparse(cast(str, self.public_url)) diff --git a/packages/api-server/api_server/default_config.py b/packages/api-server/api_server/default_config.py index 028efec7e..94d47cce4 100644 --- a/packages/api-server/api_server/default_config.py +++ b/packages/api-server/api_server/default_config.py @@ -28,4 +28,8 @@ # Used to verify the "iss" claim # If iss is set to None, it means that authentication should be disabled "iss": None, + # list of arguments passed to the ros node, "--ros-args" is automatically prepended to the list. + # e.g. + # Run with sim time: ["-p", "use_sim_time:=true"] + "ros_args": [], } diff --git a/packages/api-server/api_server/ros.py b/packages/api-server/api_server/ros.py index c94588bcd..1576b0a8b 100644 --- a/packages/api-server/api_server/ros.py +++ b/packages/api-server/api_server/ros.py @@ -5,17 +5,20 @@ import rclpy import rclpy.node +from .app_config import app_config + _spin_thread: threading.Thread = None # type: ignore +# TODO: remove support for `RMF_SERVER_USE_SIM_TIME`? use_sim_time_env = os.environ.get("RMF_SERVER_USE_SIM_TIME", None) if use_sim_time_env: use_sim_time = not use_sim_time_env.lower() in ["0", "false"] else: use_sim_time = False if use_sim_time: - rclpy.init(args=["--ros-args", "-p", "use_sim_time:=true"]) + rclpy.init(args=["--ros-args"] + app_config.ros_args + ["-p", "use_sim_time:=true"]) else: - rclpy.init() + rclpy.init(args=["--ros-args"] + app_config.ros_args) ros_node = rclpy.node.Node("rmf_api_server") diff --git a/packages/api-server/package.json b/packages/api-server/package.json index a904e9edd..9e7e3e4fa 100644 --- a/packages/api-server/package.json +++ b/packages/api-server/package.json @@ -5,7 +5,8 @@ "private": true, "scripts": { "prepack": "../../scripts/nws.sh build -d && pipenv run python setup.py bdist_wheel", - "start": "../../scripts/nws.sh build -d && pipenv run python -m api_server", + "restart": "../../scripts/nws.sh build -d && RMF_API_SERVER_CONFIG=sqlite_local_config.py pipenv run python -m api_server", + "start": "../../scripts/nws.sh build -d && rm -rf run && mkdir -p run && RMF_API_SERVER_CONFIG=sqlite_local_config.py pipenv run python -m api_server", "test": "../../scripts/nws.sh build -d && pipenv run python scripts/test.py", "test:cov": "../../scripts/nws.sh build -d && pipenv run python -m coverage run scripts/test.py", "test:report": "pipenv run python -m coverage html && xdg-open htmlcov/index.html", diff --git a/packages/api-server/psql_local_config.py b/packages/api-server/psql_local_config.py index b427820b7..ea9aa59d9 100644 --- a/packages/api-server/psql_local_config.py +++ b/packages/api-server/psql_local_config.py @@ -1,7 +1,3 @@ -from copy import deepcopy +from sqlite_local_config import config -from api_server.default_config import config as default_config - -config = deepcopy(default_config) - -config["db_url"] = "postgres://postgres:postgres@127.0.0.1:5432" +config.update({"db_url": "postgres://postgres:postgres@127.0.0.1:5432"}) diff --git a/packages/api-server/sqlite_local_config.py b/packages/api-server/sqlite_local_config.py new file mode 100644 index 000000000..3a27470a5 --- /dev/null +++ b/packages/api-server/sqlite_local_config.py @@ -0,0 +1,14 @@ +from os.path import dirname + +from api_server.default_config import config + +here = dirname(__file__) +run_dir = f"{here}/run" + +config.update( + { + "db_url": f"sqlite://{run_dir}/db.sqlite3", + "static_directory": f"{run_dir}/static", # The directory where static files should be stored. + "ros_args": ["-p", "use_sim_time:=true"], + } +) From 15c11088b1be7bb4d9a3425d3a9a534d565efd88 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 19 Jan 2022 02:11:35 +0000 Subject: [PATCH 31/79] change query fleets endpoint to get all fleets Signed-off-by: Teo Koon Peng --- .../api_server/repositories/fleets.py | 15 ++++--------- .../api-server/api_server/routes/fleets.py | 22 +++++-------------- .../api_server/routes/test_fleets.py | 2 +- 3 files changed, 11 insertions(+), 28 deletions(-) diff --git a/packages/api-server/api_server/repositories/fleets.py b/packages/api-server/api_server/repositories/fleets.py index 341e85ef5..8829ed08d 100644 --- a/packages/api-server/api_server/repositories/fleets.py +++ b/packages/api-server/api_server/repositories/fleets.py @@ -2,26 +2,19 @@ from fastapi import Depends from tortoise.query_utils import Prefetch -from tortoise.queryset import QuerySet from api_server.authenticator import user_dep -from api_server.models import FleetLog, FleetState, LogEntry, Pagination, User +from api_server.models import FleetLog, FleetState, LogEntry, User from api_server.models import tortoise_models as ttm -from api_server.query import add_pagination class FleetRepository: def __init__(self, user: User): self.user = user - async def query_fleet_states( - self, query: QuerySet[ttm.FleetState], pagination: Optional[Pagination] = None - ) -> List[FleetState]: - # TODO: enforce with authz - if pagination: - query = add_pagination(query, pagination) - results = await query.values_list("data", flat=True) - return [FleetState(**r) for r in results] + async def get_all_fleets(self) -> List[FleetState]: + db_states = await ttm.FleetState.all().values_list("data", flat=True) + return [FleetState(**s) for s in db_states] async def get_fleet_state(self, name: str) -> Optional[FleetState]: # TODO: enforce with authz diff --git a/packages/api-server/api_server/routes/fleets.py b/packages/api-server/api_server/routes/fleets.py index f296b0782..83f2bd76d 100644 --- a/packages/api-server/api_server/routes/fleets.py +++ b/packages/api-server/api_server/routes/fleets.py @@ -1,33 +1,23 @@ -from typing import List, Optional, Tuple, cast +from typing import List, Tuple, cast -from fastapi import Depends, HTTPException, Query +from fastapi import Depends, HTTPException from rx import operators as rxops from rx.subject.replaysubject import ReplaySubject -from api_server.dependencies import between_query, pagination_query, sio_user +from api_server.dependencies import between_query, sio_user from api_server.fast_io import FastIORouter, SubscriptionRequest -from api_server.models import FleetLog, FleetState, Pagination -from api_server.models.tortoise_models import FleetState as DbFleetState +from api_server.models import FleetLog, FleetState from api_server.repositories import FleetRepository, fleet_repo_dep from api_server.rmf_io import fleet_events router = FastIORouter(tags=["Fleets"]) -router = FastIORouter(tags=["Fleets"]) - @router.get("", response_model=List[FleetState]) -async def query_fleets( +async def get_fleets( repo: FleetRepository = Depends(fleet_repo_dep), - pagination: Pagination = Depends(pagination_query), - fleet_name: Optional[str] = Query( - None, description="comma separated list of fleet names" - ), ): - filters = {} - if fleet_name is not None: - filters["name__in"] = fleet_name.split(",") - return await repo.query_fleet_states(DbFleetState.filter(**filters), pagination) + return await repo.get_all_fleets() @router.get("/{name}/state", response_model=FleetState) diff --git a/packages/api-server/api_server/routes/test_fleets.py b/packages/api-server/api_server/routes/test_fleets.py index a6765ac89..29a0a67b2 100644 --- a/packages/api-server/api_server/routes/test_fleets.py +++ b/packages/api-server/api_server/routes/test_fleets.py @@ -24,7 +24,7 @@ def test_query_fleets(self): resp = self.session.get(f"/fleets?fleet_name={self.fleet_states[0].name}") self.assertEqual(200, resp.status_code) resp_json = resp.json() - self.assertEqual(len(resp_json), 1) + self.assertEqual(2, len(resp_json)) self.assertEqual(self.fleet_states[0].name, resp_json[0]["name"]) def test_get_fleet_state(self): From f4e981b993aba88371456c1147eec2900f36e77b Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 19 Jan 2022 02:46:43 +0000 Subject: [PATCH 32/79] generate task description models Signed-off-by: Teo Koon Peng --- .../api_server/models/rmf_ros2/Place.py | 25 +++++++++++ .../api_server/models/rmf_ros2/__init__.py | 2 + .../rmf_ros2/event_description_Clean.py | 13 ++++++ .../rmf_ros2/event_description_DropOff.py | 14 ++++++ .../rmf_ros2/event_description_GoToPlace.py | 16 +++++++ .../event_description_PayloadTransfer.py | 22 ++++++++++ .../rmf_ros2/event_description_PickUp.py | 14 ++++++ .../rmf_ros2/event_description_Sequence.py | 36 ++++++++++++++++ .../models/rmf_ros2/task_description_Clean.py | 14 ++++++ .../rmf_ros2/task_description_Compose.py | 40 +++++++++++++++++ .../rmf_ros2/task_description_Delivery.py | 13 ++++++ .../rmf_ros2/task_description_Patrol.py | 20 +++++++++ .../api_server/models/rmf_ros2/version.py | 4 ++ packages/api-server/generate-models.sh | 43 ++++++++++++------- 14 files changed, 260 insertions(+), 16 deletions(-) create mode 100644 packages/api-server/api_server/models/rmf_ros2/Place.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/__init__.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/event_description_Clean.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/event_description_DropOff.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/event_description_GoToPlace.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/event_description_PayloadTransfer.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/event_description_PickUp.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/event_description_Sequence.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/task_description_Clean.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/task_description_Compose.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/task_description_Delivery.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/task_description_Patrol.py create mode 100644 packages/api-server/api_server/models/rmf_ros2/version.py diff --git a/packages/api-server/api_server/models/rmf_ros2/Place.py b/packages/api-server/api_server/models/rmf_ros2/Place.py new file mode 100644 index 000000000..80782dc22 --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/Place.py @@ -0,0 +1,25 @@ +# generated by datamodel-codegen: +# filename: Place.json + +from __future__ import annotations + +from typing import Optional, Union + +from pydantic import BaseModel, Field, conint + + +class Waypoint(BaseModel): + __root__: Union[str, conint(ge=0)] + + +class PlaceDescriptionItem(BaseModel): + waypoint: Waypoint + orientation: Optional[float] = None + + +class PlaceDescription(BaseModel): + __root__: Union[Waypoint, PlaceDescriptionItem] = Field( + ..., + description="Description of a place that the robot can go to", + title="Place Description", + ) diff --git a/packages/api-server/api_server/models/rmf_ros2/__init__.py b/packages/api-server/api_server/models/rmf_ros2/__init__.py new file mode 100644 index 000000000..d31e369ef --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/__init__.py @@ -0,0 +1,2 @@ +# generated by datamodel-codegen: +# filename: schemas diff --git a/packages/api-server/api_server/models/rmf_ros2/event_description_Clean.py b/packages/api-server/api_server/models/rmf_ros2/event_description_Clean.py new file mode 100644 index 000000000..242f2da60 --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/event_description_Clean.py @@ -0,0 +1,13 @@ +# generated by datamodel-codegen: +# filename: event_description_Clean.json + +from __future__ import annotations + +from typing import Optional + +from pydantic import BaseModel + + +class CleanEvent(BaseModel): + zone: str + type: Optional[str] = None diff --git a/packages/api-server/api_server/models/rmf_ros2/event_description_DropOff.py b/packages/api-server/api_server/models/rmf_ros2/event_description_DropOff.py new file mode 100644 index 000000000..1dc181acc --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/event_description_DropOff.py @@ -0,0 +1,14 @@ +# generated by datamodel-codegen: +# filename: event_description_DropOff.json + +from __future__ import annotations + +from pydantic import BaseModel, Field + +from . import event_description_PayloadTransfer + + +class DropOffEventDescription(BaseModel): + __root__: event_description_PayloadTransfer.ItemTransferEventDescription = Field( + ..., title="Drop Off Event Description" + ) diff --git a/packages/api-server/api_server/models/rmf_ros2/event_description_GoToPlace.py b/packages/api-server/api_server/models/rmf_ros2/event_description_GoToPlace.py new file mode 100644 index 000000000..f665133e7 --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/event_description_GoToPlace.py @@ -0,0 +1,16 @@ +# generated by datamodel-codegen: +# filename: event_description_GoToPlace.json + +from __future__ import annotations + +from pydantic import BaseModel, Field + +from . import Place + + +class GoToPlaceEventDescription(BaseModel): + __root__: Place.PlaceDescription = Field( + ..., + description="Have a robot go to a place", + title="Go To Place Event Description", + ) diff --git a/packages/api-server/api_server/models/rmf_ros2/event_description_PayloadTransfer.py b/packages/api-server/api_server/models/rmf_ros2/event_description_PayloadTransfer.py new file mode 100644 index 000000000..1dd17d99f --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/event_description_PayloadTransfer.py @@ -0,0 +1,22 @@ +# generated by datamodel-codegen: +# filename: event_description_PayloadTransfer.json + +from __future__ import annotations + +from typing import List, Optional, Union + +from pydantic import BaseModel, conint + +from . import Place + + +class PayloadComponent(BaseModel): + sku: str + quantity: conint(ge=0) + compartment: Optional[str] = None + + +class ItemTransferEventDescription(BaseModel): + place: Place.PlaceDescription + handler: Optional[str] = None + payload: Union[PayloadComponent, List[PayloadComponent]] diff --git a/packages/api-server/api_server/models/rmf_ros2/event_description_PickUp.py b/packages/api-server/api_server/models/rmf_ros2/event_description_PickUp.py new file mode 100644 index 000000000..ef847021e --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/event_description_PickUp.py @@ -0,0 +1,14 @@ +# generated by datamodel-codegen: +# filename: event_description_PickUp.json + +from __future__ import annotations + +from pydantic import BaseModel, Field + +from . import event_description_PayloadTransfer + + +class PickUpEventDescription(BaseModel): + __root__: event_description_PayloadTransfer.ItemTransferEventDescription = Field( + ..., title="Pick Up Event Description" + ) diff --git a/packages/api-server/api_server/models/rmf_ros2/event_description_Sequence.py b/packages/api-server/api_server/models/rmf_ros2/event_description_Sequence.py new file mode 100644 index 000000000..9848be4dd --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/event_description_Sequence.py @@ -0,0 +1,36 @@ +# generated by datamodel-codegen: +# filename: event_description_Sequence.json + +from __future__ import annotations + +from typing import Any, List, Optional, Union + +from pydantic import BaseModel, Field + + +class ActivityArrayItem(BaseModel): + category: Optional[str] = Field(None, description="The category of the activity") + description: Optional[Any] = Field( + None, + description="A description of the activity. This must match a schema supported by a fleet for the activity category.", + ) + + +class ActivityArray(BaseModel): + __root__: List[ActivityArrayItem] = Field(..., ge=1.0) + + +class ActivitySequenceItem(BaseModel): + activities: ActivityArray + category: Optional[str] = Field( + None, description="Customize the category display for this sequence" + ) + detail: Optional[Any] = Field( + None, description="Customize the detail display for this sequence" + ) + + +class ActivitySequence(BaseModel): + __root__: Union[ActivityArray, ActivitySequenceItem] = Field( + ..., description="A sequence of activities", title="Activity Sequence" + ) diff --git a/packages/api-server/api_server/models/rmf_ros2/task_description_Clean.py b/packages/api-server/api_server/models/rmf_ros2/task_description_Clean.py new file mode 100644 index 000000000..5a8a38ff9 --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/task_description_Clean.py @@ -0,0 +1,14 @@ +# generated by datamodel-codegen: +# filename: task_description_Clean.json + +from __future__ import annotations + +from pydantic import BaseModel, Field + +from . import event_description_Clean + + +class CleanTask(BaseModel): + __root__: event_description_Clean.CleanEvent = Field( + ..., description="Clean a zone", title="Clean Task" + ) diff --git a/packages/api-server/api_server/models/rmf_ros2/task_description_Compose.py b/packages/api-server/api_server/models/rmf_ros2/task_description_Compose.py new file mode 100644 index 000000000..d888d9f8b --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/task_description_Compose.py @@ -0,0 +1,40 @@ +# generated by datamodel-codegen: +# filename: task_description_Compose.json + +from __future__ import annotations + +from typing import Any, List, Optional + +from pydantic import BaseModel, Field + + +class Activity(BaseModel): + category: str = Field(..., description="The category of this phase's activity.") + description: Any = Field( + ..., + description="A description of the activity. This must match a schema supported by a fleet for the category of this activity.", + ) + + +class Phase(BaseModel): + activity: Activity + on_cancel: Optional[List[Activity]] = Field( + None, + description="A list of activities to perform if the task is canceled during this phase. Each activity is given its own phase which can be skipped but not canceled.", + ) + + +class ComposeTaskDescription(BaseModel): + category: Optional[str] = Field( + None, + description="Specify the category for this composed task, as the operators should see it.", + ) + detail: Optional[str] = Field( + None, + description="Specify the detail for this composed task, as the operators should see it.", + ) + phases: List[Phase] = Field( + ..., + description="List the phases of the task in the order that they should be performed.", + ge=1.0, + ) diff --git a/packages/api-server/api_server/models/rmf_ros2/task_description_Delivery.py b/packages/api-server/api_server/models/rmf_ros2/task_description_Delivery.py new file mode 100644 index 000000000..8f4f91862 --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/task_description_Delivery.py @@ -0,0 +1,13 @@ +# generated by datamodel-codegen: +# filename: task_description_Delivery.json + +from __future__ import annotations + +from pydantic import BaseModel + +from . import event_description_DropOff, event_description_PickUp + + +class DeliveryTaskDescription(BaseModel): + pickup: event_description_PickUp.PickUpEventDescription + dropoff: event_description_DropOff.DropOffEventDescription diff --git a/packages/api-server/api_server/models/rmf_ros2/task_description_Patrol.py b/packages/api-server/api_server/models/rmf_ros2/task_description_Patrol.py new file mode 100644 index 000000000..a026a0a54 --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/task_description_Patrol.py @@ -0,0 +1,20 @@ +# generated by datamodel-codegen: +# filename: task_description_Patrol.json + +from __future__ import annotations + +from typing import List, Optional + +from pydantic import BaseModel, Field, conint + +from . import Place + + +class PatrolTaskDescription(BaseModel): + places: List[Place.PlaceDescription] = Field( + ..., description="A list of which places to patrol between" + ) + rounds: Optional[conint(ge=1)] = Field( + None, + description="How many times the patrol should be performed. By default this is 1.", + ) diff --git a/packages/api-server/api_server/models/rmf_ros2/version.py b/packages/api-server/api_server/models/rmf_ros2/version.py new file mode 100644 index 000000000..941d347ed --- /dev/null +++ b/packages/api-server/api_server/models/rmf_ros2/version.py @@ -0,0 +1,4 @@ +# THIS FILE IS GENERATED +version = { + "rmf_ros2": "bf038461b5b0fb7d4594461a724bc9e5e7cb97c6", +} diff --git a/packages/api-server/generate-models.sh b/packages/api-server/generate-models.sh index b0630afd6..5a49c2d90 100755 --- a/packages/api-server/generate-models.sh +++ b/packages/api-server/generate-models.sh @@ -5,6 +5,7 @@ shopt -s globstar RMF_BUILDING_MAP_MSGS_VER=c5e0352e2dfd3d11e4d292a1c2901cad867c1441 RMF_INTERNAL_MSGS_VER=0c237e1758872917661879975d7dc0acf5fa518c RMF_API_MSGS_VER=0f2d5082934acc56f8c352810f0f5db07103d788 +RMF_ROS2_VER=bf038461b5b0fb7d4594461a724bc9e5e7cb97c6 cd "$(dirname $0)" source ../../scripts/rmf-helpers.sh @@ -27,6 +28,7 @@ function fetch_sources { fetch_sources https://github.com/open-rmf/rmf_building_map_msgs.git $RMF_BUILDING_MAP_MSGS_VER build/colcon_ws/src/rmf_building_map_msgs fetch_sources https://github.com/open-rmf/rmf_internal_msgs.git $RMF_INTERNAL_MSGS_VER build/colcon_ws/src/rmf_internal_msgs fetch_sources https://github.com/open-rmf/rmf_api_msgs.git $RMF_API_MSGS_VER build/rmf_api_msgs +fetch_sources https://github.com/open-rmf/rmf_ros2.git $RMF_ROS2_VER build/rmf_ros2 # build and source colcon workspace pushd "build/colcon_ws" @@ -54,36 +56,45 @@ version = { "rmf_internal_msgs": "$RMF_INTERNAL_MSGS_VER", "rmf_building_map_msgs": "$RMF_BUILDING_MAP_MSGS_VER", } - EOF pipenv run isort api_server/models/ros_pydantic pipenv run black api_server/models/ros_pydantic -# generate rmf api models from json schemas -output='api_server/models/rmf_api' -rm -rf "$output" -mkdir -p "$output" -if [[ ! -d .venv_local/lib ]]; then - python3 -m venv .venv_local - bash -c ". .venv_local/bin/activate && pip3 install wheel && pip3 install 'datamodel-code-generator~=0.11.15'" -fi -rm -rf api_server/models/rmf_api -bash -c ". .venv_local/bin/activate && datamodel-codegen --disable-timestamp --input-file-type jsonschema --enum-field-as-literal one --input build/rmf_api_msgs/rmf_api_msgs/schemas --output \"$output\"" -cat << EOF > "$output/version.py" +generate_from_json_schema() { + input=$1 + output=$2 + upstream=$3 # the name of the package that contains the schemas + version=$4 # the version of the upstream package + + rm -rf "$output" + mkdir -p "$output" + if [[ ! -d .venv_local/lib ]]; then + python3 -m venv .venv_local + bash -c ". .venv_local/bin/activate && pip3 install wheel && pip3 install 'datamodel-code-generator~=0.11.15'" + fi + bash -c ". .venv_local/bin/activate && datamodel-codegen --disable-timestamp --input-file-type jsonschema --enum-field-as-literal one --input "$input" --output \"$output\"" + cat << EOF > "$output/version.py" # THIS FILE IS GENERATED version = { - "rmf_api_msgs": "$RMF_API_MSGS_VER", + "$upstream": "$version", } - EOF -pipenv run isort api_server/models/rmf_api -pipenv run black api_server/models/rmf_api + pipenv run isort "$output" + pipenv run black "$output" +} + +# generate rmf api models from json schemas +generate_from_json_schema build/rmf_api_msgs/rmf_api_msgs/schemas api_server/models/rmf_api rmf_api_msgs $RMF_API_MSGS_VER + +# generate builtin task descriptions from json schemas +generate_from_json_schema build/rmf_ros2/rmf_fleet_adapter/schemas api_server/models/rmf_ros2 rmf_ros2 $RMF_ROS2_VER echo '' echo 'versions:' echo " rmf_internal_msgs: $RMF_INTERNAL_MSGS_VER" echo " rmf_building_map_msgs: $RMF_BUILDING_MAP_MSGS_VER" echo " rmf_api_msgs: $RMF_API_MSGS_VER" +echo " rmf_ros2: $RMF_ROS2_VER" echo '' echo 'Successfully generated ros_pydantic models' From 8aecc8978329fa714eff7888f7b103c41172e639 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 19 Jan 2022 03:09:24 +0000 Subject: [PATCH 33/79] task states and logs do not inherit generated models so there will not be duplicates Signed-off-by: Teo Koon Peng --- .../api-server/api_server/models/__init__.py | 3 +- .../api-server/api_server/models/tasks.py | 92 ------------------- .../api_server/repositories/tasks.py | 88 +++++++++++++++++- .../api-server/api_server/rmf_gateway_app.py | 7 +- .../api_server/routes/tasks/test_tasks.py | 8 +- .../api-server/api_server/test/__init__.py | 3 + 6 files changed, 100 insertions(+), 101 deletions(-) delete mode 100644 packages/api-server/api_server/models/tasks.py diff --git a/packages/api-server/api_server/models/__init__.py b/packages/api-server/api_server/models/__init__.py index 5c30f96df..fdd23e144 100644 --- a/packages/api-server/api_server/models/__init__.py +++ b/packages/api-server/api_server/models/__init__.py @@ -28,10 +28,11 @@ from .rmf_api.skip_phase_response import SkipPhaseResponse from .rmf_api.task_discovery_request import TaskDiscoveryRequest from .rmf_api.task_discovery_response import TaskDiscovery +from .rmf_api.task_log import Phases, TaskEventLog from .rmf_api.task_log_request import TaskLogRequest from .rmf_api.task_log_response import TaskLogResponse from .rmf_api.task_request import TaskRequest +from .rmf_api.task_state import TaskState from .rmf_api.undo_skip_phase_request import UndoPhaseSkipRequest from .rmf_api.undo_skip_phase_response import UndoPhaseSkipResponse -from .tasks import TaskEventLog, TaskState from .user import * diff --git a/packages/api-server/api_server/models/tasks.py b/packages/api-server/api_server/models/tasks.py deleted file mode 100644 index 80884f49b..000000000 --- a/packages/api-server/api_server/models/tasks.py +++ /dev/null @@ -1,92 +0,0 @@ -from datetime import datetime -from typing import Dict, List, Sequence - -from tortoise.exceptions import IntegrityError -from tortoise.transactions import in_transaction - -from api_server.logger import format_exception, logger - -from . import tortoise_models as ttm -from .rmf_api import task_log -from .rmf_api.log_entry import LogEntry -from .rmf_api.task_state import TaskState as BaseTaskState - - -class TaskState(BaseTaskState): - @staticmethod - def from_db(task_state: ttm.TaskState) -> "TaskState": - return TaskState(**task_state.data) - - async def save(self) -> None: - await ttm.TaskState.update_or_create( - { - "data": self.json(), - "category": self.category, - "unix_millis_start_time": self.unix_millis_start_time - and datetime.fromtimestamp(self.unix_millis_start_time / 1000), - "unix_millis_finish_time": self.unix_millis_finish_time - and datetime.fromtimestamp(self.unix_millis_finish_time / 1000), - }, - id_=self.booking.id, - ) - - -class TaskEventLog(task_log.TaskEventLog): - async def _saveEventLogs( - self, - db_phase: ttm.TaskEventLogPhases, - events: Dict[str, List[LogEntry]], - ): - for event_id, logs in events.items(): - db_event = ( - await ttm.TaskEventLogPhasesEvents.get_or_create( - phase=db_phase, event=event_id - ) - )[0] - for log in logs: - await ttm.TaskEventLogPhasesEventsLog.create( - event=db_event, **log.dict() - ) - - async def _savePhaseLogs( - self, db_task_log: ttm.TaskEventLog, phases: Dict[str, task_log.Phases] - ): - for phase_id, phase in phases.items(): - db_phase = ( - await ttm.TaskEventLogPhases.get_or_create( - task=db_task_log, phase=phase_id - ) - )[0] - if phase.log: - for log in phase.log: - await ttm.TaskEventLogPhasesLog.create( - phase=db_phase, - **log.dict(), - ) - if phase.events: - await self._saveEventLogs(db_phase, phase.events) - - async def _saveTaskLogs( - self, db_task_log: ttm.TaskEventLog, logs: Sequence[LogEntry] - ): - for log in logs: - await ttm.TaskEventLogLog.create( - task=db_task_log, - seq=log.seq, - unix_millis_time=log.unix_millis_time, - tier=log.tier.name, - text=log.text, - ) - - async def save(self) -> None: - async with in_transaction(): - db_task_log = (await ttm.TaskEventLog.get_or_create(task_id=self.task_id))[ - 0 - ] - try: - if self.log: - await self._saveTaskLogs(db_task_log, self.log) - if self.phases: - await self._savePhaseLogs(db_task_log, self.phases) - except IntegrityError as e: - logger.error(format_exception(e)) diff --git a/packages/api-server/api_server/repositories/tasks.py b/packages/api-server/api_server/repositories/tasks.py index 0c203c219..108a33280 100644 --- a/packages/api-server/api_server/repositories/tasks.py +++ b/packages/api-server/api_server/repositories/tasks.py @@ -1,12 +1,22 @@ -from typing import List, Optional, Tuple, cast +from datetime import datetime +from typing import Dict, List, Optional, Sequence, Tuple, cast from fastapi import Depends, HTTPException -from tortoise.exceptions import FieldError +from tortoise.exceptions import FieldError, IntegrityError from tortoise.query_utils import Prefetch from tortoise.queryset import QuerySet +from tortoise.transactions import in_transaction from api_server.authenticator import user_dep -from api_server.models import LogEntry, Pagination, TaskEventLog, TaskState, User +from api_server.logger import format_exception, logger +from api_server.models import ( + LogEntry, + Pagination, + Phases, + TaskEventLog, + TaskState, + User, +) from api_server.models import tortoise_models as ttm from api_server.models.tortoise_models import TaskState as DbTaskState from api_server.query import add_pagination @@ -16,6 +26,19 @@ class TaskRepository: def __init__(self, user: User): self.user = user + async def save_task_state(self, task_state: TaskState) -> None: + await ttm.TaskState.update_or_create( + { + "data": task_state.json(), + "category": task_state.category, + "unix_millis_start_time": task_state.unix_millis_start_time + and datetime.fromtimestamp(task_state.unix_millis_start_time / 1000), + "unix_millis_finish_time": task_state.unix_millis_finish_time + and datetime.fromtimestamp(task_state.unix_millis_finish_time / 1000), + }, + id_=task_state.booking.id, + ) + async def query_task_states( self, query: QuerySet[DbTaskState], pagination: Optional[Pagination] = None ) -> List[TaskState]: @@ -78,6 +101,65 @@ async def get_task_log( phases=phases, ) + async def _saveEventLogs( + self, + db_phase: ttm.TaskEventLogPhases, + events: Dict[str, List[LogEntry]], + ): + for event_id, logs in events.items(): + db_event = ( + await ttm.TaskEventLogPhasesEvents.get_or_create( + phase=db_phase, event=event_id + ) + )[0] + for log in logs: + await ttm.TaskEventLogPhasesEventsLog.create( + event=db_event, **log.dict() + ) + + async def _savePhaseLogs( + self, db_task_log: ttm.TaskEventLog, phases: Dict[str, Phases] + ): + for phase_id, phase in phases.items(): + db_phase = ( + await ttm.TaskEventLogPhases.get_or_create( + task=db_task_log, phase=phase_id + ) + )[0] + if phase.log: + for log in phase.log: + await ttm.TaskEventLogPhasesLog.create( + phase=db_phase, + **log.dict(), + ) + if phase.events: + await self._saveEventLogs(db_phase, phase.events) + + async def _saveTaskLogs( + self, db_task_log: ttm.TaskEventLog, logs: Sequence[LogEntry] + ): + for log in logs: + await ttm.TaskEventLogLog.create( + task=db_task_log, + seq=log.seq, + unix_millis_time=log.unix_millis_time, + tier=log.tier.name, + text=log.text, + ) + + async def save_task_log(self, task_log: TaskEventLog) -> None: + async with in_transaction(): + db_task_log = ( + await ttm.TaskEventLog.get_or_create(task_id=task_log.task_id) + )[0] + try: + if task_log.log: + await self._saveTaskLogs(db_task_log, task_log.log) + if task_log.phases: + await self._savePhaseLogs(db_task_log, task_log.phases) + except IntegrityError as e: + logger.error(format_exception(e)) + def task_repo_dep(user: User = Depends(user_dep)): return TaskRepository(user) diff --git a/packages/api-server/api_server/rmf_gateway_app.py b/packages/api-server/api_server/rmf_gateway_app.py index ed4224fbd..f52ddfa22 100644 --- a/packages/api-server/api_server/rmf_gateway_app.py +++ b/packages/api-server/api_server/rmf_gateway_app.py @@ -5,10 +5,13 @@ from . import models as mdl from .logger import logger as base_logger +from .repositories import TaskRepository from .rmf_io import fleet_events, task_events app = FastAPI() logger = base_logger.getChild("RmfGatewayApp") +user: mdl.User = mdl.User(username="_rmf_gateway_app", is_admin=True) +task_repo = TaskRepository(user) async def process_msg(msg: Dict[str, Any]) -> None: @@ -21,11 +24,11 @@ async def process_msg(msg: Dict[str, Any]) -> None: if payload_type == "task_state_update": task_state = mdl.TaskState(**msg["data"]) - await task_state.save() + await task_repo.save_task_state(task_state) task_events.task_states.on_next(task_state) elif payload_type == "task_log_update": task_log = mdl.TaskEventLog(**msg["data"]) - await task_log.save() + await task_repo.save_task_log(task_log) task_events.task_event_logs.on_next(task_log) elif payload_type == "fleet_state_update": fleet_state = mdl.FleetState(**msg["data"]) diff --git a/packages/api-server/api_server/routes/tasks/test_tasks.py b/packages/api-server/api_server/routes/tasks/test_tasks.py index 6a4fca352..519507194 100644 --- a/packages/api-server/api_server/routes/tasks/test_tasks.py +++ b/packages/api-server/api_server/routes/tasks/test_tasks.py @@ -2,8 +2,9 @@ from uuid import uuid4 from api_server import models as mdl +from api_server.repositories import TaskRepository from api_server.rmf_io import task_events, tasks_service -from api_server.test import AppFixture, make_task_log, make_task_state +from api_server.test import AppFixture, make_task_log, make_task_state, test_user class TestTasksRoute(AppFixture): @@ -13,12 +14,13 @@ def setUpClass(cls): task_ids = [uuid4()] cls.task_states = [make_task_state(task_id=f"test_{x}") for x in task_ids] cls.task_logs = [make_task_log(task_id=f"test_{x}") for x in task_ids] + repo = TaskRepository(test_user) async def prepare_db(): for t in cls.task_states: - await t.save() + await repo.save_task_state(t) for t in cls.task_logs: - await t.save() + await repo.save_task_log(t) cls.run_in_app_loop(prepare_db()) diff --git a/packages/api-server/api_server/test/__init__.py b/packages/api-server/api_server/test/__init__.py index b63b468a7..5d2f462fe 100644 --- a/packages/api-server/api_server/test/__init__.py +++ b/packages/api-server/api_server/test/__init__.py @@ -1,5 +1,8 @@ from api_server.authenticator import JwtAuthenticator +from api_server.models import User from .test_data import * from .test_fixtures import * from .test_utils import * + +test_user = User(username="test_user", is_admin=True) From 4e3f02ef452d1360da2f861a9ce947069694aaec Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 19 Jan 2022 03:11:48 +0000 Subject: [PATCH 34/79] do not allow usernames starting with _ Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/models/user.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/packages/api-server/api_server/models/user.py b/packages/api-server/api_server/models/user.py index 6ae964ad5..bca23260f 100644 --- a/packages/api-server/api_server/models/user.py +++ b/packages/api-server/api_server/models/user.py @@ -19,6 +19,8 @@ async def load_from_db(username: str) -> "User": Loads an user from db, creates the user if it does not exist. NOTE: This should only be called after verifying the username comes from a trusted source (e.g. after verifying the jwt). """ + if username.startswith("_"): + raise ValueError("username cannot start with '_'") ttm_user, _ = await ttm.User.get_or_create( {"is_admin": False}, username=username ) From ec903fcb3b5574ce9f474755417fb63f3abc5549 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 19 Jan 2022 05:38:55 +0000 Subject: [PATCH 35/79] some fixes and disabling tests that are not working Signed-off-by: Teo Koon Peng --- .../lib/robots/robot-info.spec.tsx | 45 +- .../lib/robots/robot-panel.spec.tsx | 54 +- .../lib/tasks/create-task.spec.tsx | 245 +++--- packages/react-components/lib/tasks/index.ts | 3 - .../lib/tasks/task-info.spec.tsx | 25 +- .../lib/tasks/task-info.stories.tsx | 56 +- .../react-components/lib/tasks/task-info.tsx | 155 ++-- .../lib/tasks/task-logs.spec.tsx | 18 + .../lib/tasks/task-logs.stories.tsx | 29 + .../react-components/lib/tasks/task-logs.tsx | 107 +++ .../lib/tasks/task-phases.stories.tsx | 19 - .../lib/tasks/task-phases.tsx | 156 ---- .../lib/tasks/task-summary-accordion.spec.tsx | 207 ----- .../tasks/task-summary-accordion.stories.tsx | 34 - .../lib/tasks/task-summary-accordion.tsx | 214 ----- .../lib/tasks/task-summary-utils.ts | 85 -- .../lib/tasks/task-table.spec.tsx | 26 +- .../lib/tasks/task-table.stories.tsx | 27 +- .../react-components/lib/tasks/task-table.tsx | 53 +- .../lib/tasks/task-timeline.spec.tsx | 53 +- .../lib/tasks/task-timeline.stories.tsx | 44 +- .../lib/tasks/task-timeline.tsx | 145 +--- .../lib/tasks/test-data.spec.ts | 778 ++++++++++++------ packages/react-components/lib/tasks/utils.ts | 22 - 24 files changed, 1042 insertions(+), 1558 deletions(-) create mode 100644 packages/react-components/lib/tasks/task-logs.spec.tsx create mode 100644 packages/react-components/lib/tasks/task-logs.stories.tsx create mode 100644 packages/react-components/lib/tasks/task-logs.tsx delete mode 100644 packages/react-components/lib/tasks/task-phases.stories.tsx delete mode 100644 packages/react-components/lib/tasks/task-phases.tsx delete mode 100644 packages/react-components/lib/tasks/task-summary-accordion.spec.tsx delete mode 100644 packages/react-components/lib/tasks/task-summary-accordion.stories.tsx delete mode 100644 packages/react-components/lib/tasks/task-summary-accordion.tsx delete mode 100644 packages/react-components/lib/tasks/task-summary-utils.ts diff --git a/packages/react-components/lib/robots/robot-info.spec.tsx b/packages/react-components/lib/robots/robot-info.spec.tsx index f6427bf1d..f003c9c51 100644 --- a/packages/react-components/lib/robots/robot-info.spec.tsx +++ b/packages/react-components/lib/robots/robot-info.spec.tsx @@ -2,32 +2,31 @@ import { render } from '@testing-library/react'; import type { Task } from 'api-client'; import React from 'react'; import { TaskType as RmfTaskType } from 'rmf-models'; -import { makeTaskSummaryWithPhases } from '../tasks/test-data.spec'; import { RobotInfo } from './robot-info'; import { makeRandomRobot } from './test-utils.spec'; -describe('RobotInfo', () => { - it('information renders correctly', () => { - const robot = makeRandomRobot('test_robot', 'test_fleet', 1); - const deliveryTask = makeTaskSummaryWithPhases('delivery_task', 1, 1); - deliveryTask.task_profile.description.task_type.type = RmfTaskType.TYPE_DELIVERY; - deliveryTask.task_profile.description.delivery.pickup_place_name = 'test_waypoint_1'; - deliveryTask.task_profile.description.delivery.pickup_dispenser = 'test_dispenser'; - deliveryTask.task_profile.description.delivery.dropoff_place_name = 'test_waypoint_2'; - deliveryTask.task_profile.description.delivery.dropoff_ingestor = 'test_ingestor'; - const task: Task = { - summary: deliveryTask, - progress: { status: '10' }, - task_id: 'delivery_task', - }; +// describe('RobotInfo', () => { +// it('information renders correctly', () => { +// const robot = makeRandomRobot('test_robot', 'test_fleet', 1); +// const deliveryTask = makeTaskSummaryWithPhases('delivery_task', 1, 1); +// deliveryTask.task_profile.description.task_type.type = RmfTaskType.TYPE_DELIVERY; +// deliveryTask.task_profile.description.delivery.pickup_place_name = 'test_waypoint_1'; +// deliveryTask.task_profile.description.delivery.pickup_dispenser = 'test_dispenser'; +// deliveryTask.task_profile.description.delivery.dropoff_place_name = 'test_waypoint_2'; +// deliveryTask.task_profile.description.delivery.dropoff_ingestor = 'test_ingestor'; +// const task: Task = { +// summary: deliveryTask, +// progress: { status: '10' }, +// task_id: 'delivery_task', +// }; - const robot1 = { ...robot, tasks: [task] }; +// const robot1 = { ...robot, tasks: [task] }; - const root = render(); +// const root = render(); - expect(root.getByRole('heading', { name: 'test_robot' })).toBeTruthy(); - expect(root.getByRole('button', { name: 'delivery_task' })).toBeTruthy(); - expect(root.getByRole('button', { name: 'test_waypoint_1' })).toBeTruthy(); - expect(root.getByRole('button', { name: 'test_waypoint_2' })).toBeTruthy(); - }); -}); +// expect(root.getByRole('heading', { name: 'test_robot' })).toBeTruthy(); +// expect(root.getByRole('button', { name: 'delivery_task' })).toBeTruthy(); +// expect(root.getByRole('button', { name: 'test_waypoint_1' })).toBeTruthy(); +// expect(root.getByRole('button', { name: 'test_waypoint_2' })).toBeTruthy(); +// }); +// }); diff --git a/packages/react-components/lib/robots/robot-panel.spec.tsx b/packages/react-components/lib/robots/robot-panel.spec.tsx index f325c5e23..5b576162c 100644 --- a/packages/react-components/lib/robots/robot-panel.spec.tsx +++ b/packages/react-components/lib/robots/robot-panel.spec.tsx @@ -1,7 +1,7 @@ import { render } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React from 'react'; -import { makeDefinedTask } from '../tasks/test-data.spec'; +// import { makeDefinedTask } from '../tasks/test-data.spec'; import { RobotPanel, RobotPanelProps } from './robot-panel'; import { makeRandomRobot } from './test-utils.spec'; import { VerboseRobot } from './utils'; @@ -12,30 +12,30 @@ function makeFetchRobots(robots: VerboseRobot[]): RobotPanelProps['fetchVerboseR }; } -describe('RobotPanel', () => { - it('shows empty information when robot is clicked when there are no assigned tasks', async () => { - const robots = [makeRandomRobot('test_robot1', 'test_fleet', 2)]; - const root = render( - , - ); - await userEvent.click(root.getByText('test_robot1')); - expect(root.getByRole('heading', { name: 'test_robot1' })).toBeTruthy(); - expect(root.getAllByRole('button', { name: '-' }).length).toBe(4); - }); +// describe('RobotPanel', () => { +// it('shows empty information when robot is clicked when there are no assigned tasks', async () => { +// const robots = [makeRandomRobot('test_robot1', 'test_fleet', 2)]; +// const root = render( +// , +// ); +// await userEvent.click(root.getByText('test_robot1')); +// expect(root.getByRole('heading', { name: 'test_robot1' })).toBeTruthy(); +// expect(root.getAllByRole('button', { name: '-' }).length).toBe(4); +// }); - it('shows detailed information when robot is clicked', async () => { - const tasks = [ - { ...makeDefinedTask('Loop', 'test_robot1', 'task_1', 3, 3), progress: { status: '10%' } }, - ]; - const robot = makeRandomRobot('test_robot1', 'test_fleet', 2); - const verboseRobot = [{ ...robot, tasks }]; - const root = render( - , - ); - await userEvent.click(root.getByText('test_robot1')); - expect(root.getByRole('progressbar')).toBeTruthy(); - }); -}); +// it('shows detailed information when robot is clicked', async () => { +// const tasks = [ +// { ...makeDefinedTask('Loop', 'test_robot1', 'task_1', 3, 3), progress: { status: '10%' } }, +// ]; +// const robot = makeRandomRobot('test_robot1', 'test_fleet', 2); +// const verboseRobot = [{ ...robot, tasks }]; +// const root = render( +// , +// ); +// await userEvent.click(root.getByText('test_robot1')); +// expect(root.getByRole('progressbar')).toBeTruthy(); +// }); +// }); diff --git a/packages/react-components/lib/tasks/create-task.spec.tsx b/packages/react-components/lib/tasks/create-task.spec.tsx index d38bdb503..d961861d0 100644 --- a/packages/react-components/lib/tasks/create-task.spec.tsx +++ b/packages/react-components/lib/tasks/create-task.spec.tsx @@ -1,142 +1,135 @@ -import { render, RenderResult, waitForElementToBeRemoved, within } from '@testing-library/react'; -import userEvent from '@testing-library/user-event'; -import type { - CleanTaskDescription, - DeliveryTaskDescription, - LoopTaskDescription, - SubmitTask, -} from 'api-client'; +// import { render, RenderResult, waitForElementToBeRemoved, within } from '@testing-library/react'; +// import userEvent from '@testing-library/user-event'; import React from 'react'; -import { TaskType as RmfTaskType } from 'rmf-models'; -import { CreateTaskForm } from './create-task'; -import { makeSubmitTask } from './test-data.spec'; +// import { TaskType as RmfTaskType } from 'rmf-models'; +// import { CreateTaskForm } from './create-task'; -const getTaskTypeEl = (root: RenderResult) => root.getByLabelText('Task Type'); +// const getTaskTypeEl = (root: RenderResult) => root.getByLabelText('Task Type'); -describe('CreateTaskForm', () => { - describe('submit tasks', () => { - it('is called with correct clean task data when form is submitted', async () => { - const spy = jasmine.createSpy().and.resolveTo(undefined); - const root = render(); - userEvent.click(getTaskTypeEl(root)); - userEvent.click(root.getByRole('option', { name: 'Clean' })); - await waitForElementToBeRemoved(() => root.getByRole('option', { name: 'Clean' })); - userEvent.type(root.getByLabelText('Cleaning Zone'), 'test_zone'); - userEvent.click(root.getByText('Submit')); +// describe('CreateTaskForm', () => { +// describe('submit tasks', () => { +// it('is called with correct clean task data when form is submitted', async () => { +// const spy = jasmine.createSpy().and.resolveTo(undefined); +// const root = render(); +// userEvent.click(getTaskTypeEl(root)); +// userEvent.click(root.getByRole('option', { name: 'Clean' })); +// await waitForElementToBeRemoved(() => root.getByRole('option', { name: 'Clean' })); +// userEvent.type(root.getByLabelText('Cleaning Zone'), 'test_zone'); +// userEvent.click(root.getByText('Submit')); - expect(spy).toHaveBeenCalledTimes(1); - const task = spy.calls.argsFor(0)[0][0] as SubmitTask; - expect((task.description as CleanTaskDescription).cleaning_zone).toBe('test_zone'); - }); +// expect(spy).toHaveBeenCalledTimes(1); +// const task = spy.calls.argsFor(0)[0][0] as SubmitTask; +// expect((task.description as CleanTaskDescription).cleaning_zone).toBe('test_zone'); +// }); - it('is called with correct loop task data when form is submitted', async () => { - const spy = jasmine.createSpy().and.resolveTo(undefined); - const root = render(); - userEvent.click(getTaskTypeEl(root)); - userEvent.click(root.getByRole('option', { name: 'Loop' })); - await waitForElementToBeRemoved(() => root.getByRole('option', { name: 'Clean' })); - userEvent.type(root.getByLabelText('Start Location'), 'start'); - userEvent.type(root.getByLabelText('Finish Location'), 'finish'); - const loopsInput = root.getByLabelText('Loops'); - userEvent.clear(loopsInput); - userEvent.type(loopsInput, '2'); - userEvent.click(root.getByText('Submit')); +// it('is called with correct loop task data when form is submitted', async () => { +// const spy = jasmine.createSpy().and.resolveTo(undefined); +// const root = render(); +// userEvent.click(getTaskTypeEl(root)); +// userEvent.click(root.getByRole('option', { name: 'Loop' })); +// await waitForElementToBeRemoved(() => root.getByRole('option', { name: 'Clean' })); +// userEvent.type(root.getByLabelText('Start Location'), 'start'); +// userEvent.type(root.getByLabelText('Finish Location'), 'finish'); +// const loopsInput = root.getByLabelText('Loops'); +// userEvent.clear(loopsInput); +// userEvent.type(loopsInput, '2'); +// userEvent.click(root.getByText('Submit')); - expect(spy).toHaveBeenCalledTimes(1); - const task = spy.calls.argsFor(0)[0][0] as SubmitTask; - const desc = task.description as LoopTaskDescription; - expect(desc.start_name).toBe('start'); - expect(desc.finish_name).toBe('finish'); - expect(desc.num_loops).toBe(2); - }); +// expect(spy).toHaveBeenCalledTimes(1); +// const task = spy.calls.argsFor(0)[0][0] as SubmitTask; +// const desc = task.description as LoopTaskDescription; +// expect(desc.start_name).toBe('start'); +// expect(desc.finish_name).toBe('finish'); +// expect(desc.num_loops).toBe(2); +// }); - it('is called with correct delivery task data when form is submitted', async () => { - const spy = jasmine.createSpy().and.resolveTo(undefined); - const root = render(); - userEvent.click(getTaskTypeEl(root)); - userEvent.click(root.getByRole('option', { name: 'Delivery' })); - await waitForElementToBeRemoved(() => root.getByRole('option', { name: 'Delivery' })); - userEvent.type(root.getByLabelText('Pickup Location'), 'pickup_location'); - userEvent.type(root.getByLabelText('Dispenser'), 'pickup_dispenser'); - userEvent.type(root.getByLabelText('Dropoff Location'), 'dropoff_location'); - userEvent.type(root.getByLabelText('Ingestor'), 'dropoff_ingestor'); - userEvent.click(root.getByText('Submit')); +// it('is called with correct delivery task data when form is submitted', async () => { +// const spy = jasmine.createSpy().and.resolveTo(undefined); +// const root = render(); +// userEvent.click(getTaskTypeEl(root)); +// userEvent.click(root.getByRole('option', { name: 'Delivery' })); +// await waitForElementToBeRemoved(() => root.getByRole('option', { name: 'Delivery' })); +// userEvent.type(root.getByLabelText('Pickup Location'), 'pickup_location'); +// userEvent.type(root.getByLabelText('Dispenser'), 'pickup_dispenser'); +// userEvent.type(root.getByLabelText('Dropoff Location'), 'dropoff_location'); +// userEvent.type(root.getByLabelText('Ingestor'), 'dropoff_ingestor'); +// userEvent.click(root.getByText('Submit')); - expect(spy).toHaveBeenCalledTimes(1); - const task = spy.calls.argsFor(0)[0][0] as SubmitTask; - const desc = task.description as DeliveryTaskDescription; - expect(desc.pickup_place_name).toBe('pickup_location'); - expect(desc.pickup_dispenser).toBe('pickup_dispenser'); - expect(desc.dropoff_place_name).toBe('dropoff_location'); - expect(desc.dropoff_ingestor).toBe('dropoff_ingestor'); - }); - }); +// expect(spy).toHaveBeenCalledTimes(1); +// const task = spy.calls.argsFor(0)[0][0] as SubmitTask; +// const desc = task.description as DeliveryTaskDescription; +// expect(desc.pickup_place_name).toBe('pickup_location'); +// expect(desc.pickup_dispenser).toBe('pickup_dispenser'); +// expect(desc.dropoff_place_name).toBe('dropoff_location'); +// expect(desc.dropoff_ingestor).toBe('dropoff_ingestor'); +// }); +// }); - it('onClose is called when cancel button is clicked', () => { - const spy = jasmine.createSpy(); - const root = render(); - userEvent.click(root.getByText('Cancel')); - expect(spy).toHaveBeenCalledTimes(1); - }); +// it('onClose is called when cancel button is clicked', () => { +// const spy = jasmine.createSpy(); +// const root = render(); +// userEvent.click(root.getByText('Cancel')); +// expect(spy).toHaveBeenCalledTimes(1); +// }); - it('onFail is called when submitTasks fails', async () => { - const submitSpy = jasmine.createSpy().and.rejectWith(new Error('error!!')); - const failSpy = jasmine.createSpy(); - const root = render(); - userEvent.click(root.getByText('Submit')); - await new Promise((res) => setTimeout(res, 0)); - expect(failSpy).toHaveBeenCalledTimes(1); - }); +// it('onFail is called when submitTasks fails', async () => { +// const submitSpy = jasmine.createSpy().and.rejectWith(new Error('error!!')); +// const failSpy = jasmine.createSpy(); +// const root = render(); +// userEvent.click(root.getByText('Submit')); +// await new Promise((res) => setTimeout(res, 0)); +// expect(failSpy).toHaveBeenCalledTimes(1); +// }); - it('tasksFromFile is called when select file button is clicked', () => { - const spy = jasmine.createSpy().and.resolveTo([]); - const root = render(); - userEvent.click(root.getByLabelText('Select File')); - expect(spy).toHaveBeenCalledTimes(1); - }); +// it('tasksFromFile is called when select file button is clicked', () => { +// const spy = jasmine.createSpy().and.resolveTo([]); +// const root = render(); +// userEvent.click(root.getByLabelText('Select File')); +// expect(spy).toHaveBeenCalledTimes(1); +// }); - describe('task list', () => { - const mount = () => { - const task1 = makeSubmitTask(); - task1.description = { cleaning_zone: 'clean' } as CleanTaskDescription; - task1.task_type = RmfTaskType.TYPE_CLEAN; - const task2 = makeSubmitTask(); - task2.description = { - start_name: 'start', - finish_name: 'finish', - num_loops: 2, - } as LoopTaskDescription; - task2.task_type = RmfTaskType.TYPE_LOOP; - const tasksFromFile = () => Promise.resolve([task1, task2]); - const root = render(); - userEvent.click(root.getByLabelText('Select File')); +// describe('task list', () => { +// const mount = () => { +// const task1 = makeSubmitTask(); +// task1.description = { cleaning_zone: 'clean' } as CleanTaskDescription; +// task1.task_type = RmfTaskType.TYPE_CLEAN; +// const task2 = makeSubmitTask(); +// task2.description = { +// start_name: 'start', +// finish_name: 'finish', +// num_loops: 2, +// } as LoopTaskDescription; +// task2.task_type = RmfTaskType.TYPE_LOOP; +// const tasksFromFile = () => Promise.resolve([task1, task2]); +// const root = render(); +// userEvent.click(root.getByLabelText('Select File')); - const getTaskList = async () => root.findByLabelText('Tasks List'); - const getTaskItems = async () => within(await getTaskList()).getAllByRole('listitem'); +// const getTaskList = async () => root.findByLabelText('Tasks List'); +// const getTaskItems = async () => within(await getTaskList()).getAllByRole('listitem'); - return { - root, - q: { - getTaskList, - getTaskItems, - }, - }; - }; +// return { +// root, +// q: { +// getTaskList, +// getTaskItems, +// }, +// }; +// }; - it('is shown when file is imported', async () => { - const { q } = mount(); - const taskItems = await q.getTaskItems(); - expect(taskItems.length).toBe(2); - }); +// it('is shown when file is imported', async () => { +// const { q } = mount(); +// const taskItems = await q.getTaskItems(); +// expect(taskItems.length).toBe(2); +// }); - it('clicking on item updates the form', async () => { - const { root, q } = mount(); - const tasks = await q.getTaskItems(); - expect(tasks.length).toBeGreaterThan(0); - userEvent.click(tasks[0]); - within(getTaskTypeEl(root)).getByText('Clean'); - userEvent.click(tasks[1]); - within(getTaskTypeEl(root)).getByText('Loop'); - }); - }); -}); +// it('clicking on item updates the form', async () => { +// const { root, q } = mount(); +// const tasks = await q.getTaskItems(); +// expect(tasks.length).toBeGreaterThan(0); +// userEvent.click(tasks[0]); +// within(getTaskTypeEl(root)).getByText('Clean'); +// userEvent.click(tasks[1]); +// within(getTaskTypeEl(root)).getByText('Loop'); +// }); +// }); +// }); diff --git a/packages/react-components/lib/tasks/index.ts b/packages/react-components/lib/tasks/index.ts index 3926a99d8..65ea42778 100644 --- a/packages/react-components/lib/tasks/index.ts +++ b/packages/react-components/lib/tasks/index.ts @@ -1,7 +1,4 @@ export * from './create-task'; export * from './task-info'; -export * from './task-phases'; -export * from './task-summary-accordion'; -export * from './task-summary-utils'; export * from './task-table'; export * from './task-timeline'; diff --git a/packages/react-components/lib/tasks/task-info.spec.tsx b/packages/react-components/lib/tasks/task-info.spec.tsx index 37c8a872c..22ca691f0 100644 --- a/packages/react-components/lib/tasks/task-info.spec.tsx +++ b/packages/react-components/lib/tasks/task-info.spec.tsx @@ -1,33 +1,14 @@ import { render } from '@testing-library/react'; import React from 'react'; -import { TaskType as RmfTaskType } from 'rmf-models'; import { TaskInfo } from './task-info'; -import { makeTaskSummaryWithPhases } from './test-data.spec'; +import { makeTaskState } from './test-data.spec'; describe('TaskInfo', () => { it('smoke test', () => { - const cleanTask = makeTaskSummaryWithPhases('clean_task', 1, 1); - cleanTask.task_profile.description.task_type.type = RmfTaskType.TYPE_CLEAN; - cleanTask.task_profile.description.clean.start_waypoint = 'test_waypoint'; - - const loopTask = makeTaskSummaryWithPhases('loop_task', 1, 1); - loopTask.task_profile.description.task_type.type = RmfTaskType.TYPE_LOOP; - loopTask.task_profile.description.loop.start_name = 'test_waypoint_1'; - loopTask.task_profile.description.loop.finish_name = 'test_waypoint_2'; - loopTask.task_profile.description.loop.num_loops = 3; - - const deliveryTask = makeTaskSummaryWithPhases('delivery_task', 1, 1); - deliveryTask.task_profile.description.task_type.type = RmfTaskType.TYPE_DELIVERY; - deliveryTask.task_profile.description.delivery.pickup_place_name = 'test_waypoint_1'; - deliveryTask.task_profile.description.delivery.pickup_dispenser = 'test_dispenser'; - deliveryTask.task_profile.description.delivery.dropoff_place_name = 'test_waypoint_2'; - deliveryTask.task_profile.description.delivery.dropoff_ingestor = 'test_ingestor'; - + const task = makeTaskState('task'); render( <> - - - + , ); }); diff --git a/packages/react-components/lib/tasks/task-info.stories.tsx b/packages/react-components/lib/tasks/task-info.stories.tsx index 25868a492..d4749a652 100644 --- a/packages/react-components/lib/tasks/task-info.stories.tsx +++ b/packages/react-components/lib/tasks/task-info.stories.tsx @@ -1,64 +1,22 @@ +import { Paper } from '@mui/material'; import { Meta, Story } from '@storybook/react'; import React from 'react'; -import { TaskType as RmfTaskType } from 'rmf-models'; import { TaskInfo, TaskInfoProps } from './task-info'; -import { makeTaskSummaryWithPhases } from './test-data.spec'; -import { Paper } from '@mui/material'; +import { makeTaskState } from './test-data.spec'; export default { - title: 'Tasks/Task Infos', + title: 'Tasks/Task Info', component: TaskInfo, } as Meta; -export const CleanTask: Story = (args) => { - return ( - - - - ); -}; - -const cleanTask = makeTaskSummaryWithPhases('clean_task', 1, 1); -cleanTask.task_profile.description.task_type.type = RmfTaskType.TYPE_CLEAN; -cleanTask.task_profile.description.clean.start_waypoint = 'test_waypoint'; - -CleanTask.args = { - task: cleanTask, -}; - -export const LoopTask: Story = (args) => { +export const Default: Story = (args) => { return ( ); }; - -const loopTask = makeTaskSummaryWithPhases('loop_task', 1, 1); -loopTask.task_profile.description.task_type.type = RmfTaskType.TYPE_LOOP; -loopTask.task_profile.description.loop.start_name = 'test_waypoint_1'; -loopTask.task_profile.description.loop.finish_name = 'test_waypoint_2'; -loopTask.task_profile.description.loop.num_loops = 3; - -LoopTask.args = { - task: loopTask, -}; - -export const DeliveryTask: Story = (args) => { - return ( - - - - ); -}; - -const deliveryTask = makeTaskSummaryWithPhases('delivery_task', 1, 1); -deliveryTask.task_profile.description.task_type.type = RmfTaskType.TYPE_DELIVERY; -deliveryTask.task_profile.description.delivery.pickup_place_name = 'test_waypoint_1'; -deliveryTask.task_profile.description.delivery.pickup_dispenser = 'test_dispenser'; -deliveryTask.task_profile.description.delivery.dropoff_place_name = 'test_waypoint_2'; -deliveryTask.task_profile.description.delivery.dropoff_ingestor = 'test_ingestor'; - -DeliveryTask.args = { - task: deliveryTask, +Default.storyName = 'Task Info'; +Default.args = { + task: makeTaskState('task'), }; diff --git a/packages/react-components/lib/tasks/task-info.tsx b/packages/react-components/lib/tasks/task-info.tsx index c8073799c..26a23b77b 100644 --- a/packages/react-components/lib/tasks/task-info.tsx +++ b/packages/react-components/lib/tasks/task-info.tsx @@ -3,7 +3,6 @@ import { styled } from '@mui/material'; import type { TaskState } from 'api-client'; import React from 'react'; import { TaskTimeline } from './task-timeline'; -import { parseTaskDetail, getState } from './utils'; const classes = { infoValue: 'task-info-info-value', @@ -27,91 +26,89 @@ function InfoValue({ children }: React.PropsWithChildren) { return {children}; } -interface CleanTaskInfoProps { - task: TaskState; -} +// interface CleanTaskInfoProps { +// task: TaskState; +// } -function CleanTaskInfo({ task }: CleanTaskInfoProps) { - return ( - - Start Waypoint: - {parseTaskDetail(task, task?.category).to} - - ); -} +// function CleanTaskInfo({ task }: CleanTaskInfoProps) { +// return ( +// +// Start Waypoint: +// {parseTaskDetail(task, task?.category).to} +// +// ); +// } -interface LoopTaskInfoProps { - task: TaskState; -} +// interface LoopTaskInfoProps { +// task: TaskState; +// } -function LoopTaskInfo({ task }: LoopTaskInfoProps) { - return ( - <> - - Start Waypoint: - {parseTaskDetail(task, task?.category).from} - - - Finish Waypoint: - {parseTaskDetail(task, task?.category).to} - - - Num of Loops: - {task.phases ? Object.keys(task.phases).length / 2 : null} - - - ); -} +// function LoopTaskInfo({ task }: LoopTaskInfoProps) { +// return ( +// <> +// +// Start Waypoint: +// {parseTaskDetail(task, task?.category).from} +// +// +// Finish Waypoint: +// {parseTaskDetail(task, task?.category).to} +// +// +// Num of Loops: +// {task.phases ? Object.keys(task.phases).length / 2 : null} +// +// +// ); +// } -interface DeliveryTaskInfoProps { - task: TaskState; -} +// interface DeliveryTaskInfoProps { +// task: TaskState; +// } -function DeliveryTaskInfoProps({ task }: DeliveryTaskInfoProps) { - // TODO - replace all temp values - return ( - <> - - Pickup Location: - {'temp'} - - - Pickup Dispenser: - {'temp'} - - - Dropoff Location: - {parseTaskDetail(task, task?.category).from} - - - Dropoff Ingestor: - {parseTaskDetail(task, task?.category).to} - - - ); -} +// function DeliveryTaskInfoProps({ task }: DeliveryTaskInfoProps) { +// // TODO - replace all temp values +// return ( +// <> +// +// Pickup Location: +// {'temp'} +// +// +// Pickup Dispenser: +// {'temp'} +// +// +// Dropoff Location: +// {parseTaskDetail(task, task?.category).from} +// +// +// Dropoff Ingestor: +// {parseTaskDetail(task, task?.category).to} +// +// +// ); +// } export interface TaskInfoProps { task: TaskState; - showLogs: boolean; - onShowLogs?: React.Dispatch>; } -export function TaskInfo({ task, showLogs, onShowLogs }: TaskInfoProps): JSX.Element { +export function TaskInfo({ task }: TaskInfoProps): JSX.Element { const theme = useTheme(); - const taskType = task.category; - const detailInfo = (() => { - switch (taskType) { - case 'Clean': - return ; - case 'Loop': - return ; - case 'Delivery': - return ; - default: - return null; - } - })(); + // const taskType = task.category; + // const detailInfo = (() => { + // switch (taskType) { + // case 'Clean': + // return ; + // case 'Loop': + // return ; + // case 'Delivery': + // return ; + // default: + // return null; + // } + // })(); return ( @@ -122,15 +119,15 @@ export function TaskInfo({ task, showLogs, onShowLogs }: TaskInfoProps): JSX.Ele
State: - {getState(task)} + {task.status || 'unknown'} - {detailInfo} -
+ {/* {detailInfo} */} + {/*
Progress -
+
*/}
diff --git a/packages/react-components/lib/tasks/task-logs.spec.tsx b/packages/react-components/lib/tasks/task-logs.spec.tsx new file mode 100644 index 000000000..cc335a6ff --- /dev/null +++ b/packages/react-components/lib/tasks/task-logs.spec.tsx @@ -0,0 +1,18 @@ +import { render } from '@testing-library/react'; +import React from 'react'; +import { TaskLogs } from './task-logs'; +import { makeTaskLog } from './test-data.spec'; + +describe('TaskLogs', () => { + it('shows all event logs', () => { + const logs = makeTaskLog('task'); + const root = render(); + Object.values(logs.phases).forEach((p) => { + Object.values(p.events).forEach((e) => { + e.forEach((l) => { + expect(root.getAllByText(l.text).length).toBeGreaterThan(0); + }); + }); + }); + }); +}); diff --git a/packages/react-components/lib/tasks/task-logs.stories.tsx b/packages/react-components/lib/tasks/task-logs.stories.tsx new file mode 100644 index 000000000..e29d257e5 --- /dev/null +++ b/packages/react-components/lib/tasks/task-logs.stories.tsx @@ -0,0 +1,29 @@ +import { Meta, Story } from '@storybook/react'; +import React from 'react'; +import { TaskLogs, TaskLogsProps } from './task-logs'; +import { makeTaskLog } from './test-data.spec'; + +export default { + title: 'Tasks/Logs', + component: TaskLogs, + argTypes: { + paginationOptions: { + control: { + disable: true, + }, + }, + submitTask: { + control: { + disable: true, + }, + }, + }, +} as Meta; + +export const Logs: Story = (args) => { + return ; +}; + +Logs.args = { + taskLog: makeTaskLog('task'), +}; diff --git a/packages/react-components/lib/tasks/task-logs.tsx b/packages/react-components/lib/tasks/task-logs.tsx new file mode 100644 index 000000000..8cd2010c9 --- /dev/null +++ b/packages/react-components/lib/tasks/task-logs.tsx @@ -0,0 +1,107 @@ +import { Divider, Grid, Paper, PaperProps, styled, Typography, useTheme } from '@mui/material'; +import { TaskEventLog } from 'api-client'; +import React from 'react'; + +const prefix = 'task-logs'; +const classes = { + root: `${prefix}-root`, +}; + +export interface TaskLogsProps { + taskLog: TaskEventLog; +} + +const StyledPaper = styled((props: PaperProps) => )( + ({ theme }) => ({ + [`&.${classes.root}`]: { + padding: theme.spacing(2), + marginLeft: theme.spacing(2), + flex: '0 0 auto', + }, + }), +); + +export function TaskLogs(props: TaskLogsProps) { + const { taskLog } = props; + const theme = useTheme(); + const phaseIds = taskLog.phases ? Object.keys(taskLog.phases) : []; + return ( + + + {taskLog.task_id} + + + {phaseIds.length > 0 ? ( + phaseIds.map((id: string) => { + const getEventObj: any = taskLog.phases ? taskLog.phases[id] : null; + const events = getEventObj ? getEventObj['events'] : {}; + const eventIds = events ? Object.keys(events) : []; + return ( + + + {`Phase - ${id}`} + + + {eventIds.length > 0 ? ( + eventIds.map((idx) => { + const event = events[idx]; + return ( +
+ {`Event - ${idx}`} + {event.map((e: any, i: any) => { + return ( + + + + {new Date(e.unix_millis_time).toLocaleString()} + + + + {e.text} + + + ); + })} +
+ ); + }) + ) : ( + + No Event Logs + + )} + + ); + }) + ) : ( +
+ + No Logs + +
+ )} + + ); +} diff --git a/packages/react-components/lib/tasks/task-phases.stories.tsx b/packages/react-components/lib/tasks/task-phases.stories.tsx deleted file mode 100644 index e8d3fe964..000000000 --- a/packages/react-components/lib/tasks/task-phases.stories.tsx +++ /dev/null @@ -1,19 +0,0 @@ -import { Meta, Story } from '@storybook/react'; -import React from 'react'; -import { TaskPhases, TaskPhasesProps } from './task-phases'; -import { makeTaskSummaryWithPhases } from './test-data.spec'; - -const task = makeTaskSummaryWithPhases('test_task', 3, 3); - -export default { - title: 'Tasks/Phases', - component: TaskPhases, -} as Meta; - -export const Phases: Story = (args) => { - return ; -}; - -Phases.args = { - taskSummary: task, -}; diff --git a/packages/react-components/lib/tasks/task-phases.tsx b/packages/react-components/lib/tasks/task-phases.tsx deleted file mode 100644 index 7b319b4b8..000000000 --- a/packages/react-components/lib/tasks/task-phases.tsx +++ /dev/null @@ -1,156 +0,0 @@ -import { Box, BoxProps, Grid, Theme, Tooltip, Typography, useTheme, styled } from '@mui/material'; -import clsx from 'clsx'; -import React from 'react'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; - -const classes = { - taskPhasesContainer: 'task-phase-container', - taskPhase: 'task-phase-phase-component', - pendingPhase: 'task-phase-pending-phase', - completedPhase: 'task-phase-completed-phase', - failedPhase: 'task-phase-failed-phase', - phaseSeparator: 'task-phase-phase-separator', - phaseStatus: 'task-phase-phase-status', -}; -const StyledBox = styled((props: BoxProps) => )(({ theme }) => ({ - [`& .${classes.taskPhasesContainer}`]: { - overflowX: 'auto', - }, - [`& .${classes.taskPhase}`]: { - padding: theme.spacing(1), - borderRadius: theme.shape.borderRadius, - flex: '1 1 0', - minWidth: 100, - }, - [`& .${classes.pendingPhase}`]: { - background: theme.palette.info.light, - }, - [`& .${classes.completedPhase}`]: { - background: theme.palette.success.light, - }, - [`& .${classes.failedPhase}`]: { - background: theme.palette.error.light, - }, - [`& .${classes.phaseSeparator}`]: { - position: 'relative', - left: theme.spacing(-1), - margin: `0 ${theme.spacing(-2)}px 0 0`, - }, - [`& .${classes.phaseStatus}`]: { - textOverflow: 'ellipsis', - overflow: 'hidden', - whiteSpace: 'nowrap', - }, -})); - -const getPhaseColors = (theme: Theme) => ({ - pending: theme.palette.info.light, - completed: theme.palette.success.light, - failed: theme.palette.error.light, -}); - -interface PhaseProps extends React.HTMLProps { - status: string; -} - -function Phase({ status, ...divProps }: PhaseProps) { - const lines = status.split('\n'); - return ( -
- {lines.map((l, idx) => ( - - - {l} - - - ))} -
- ); -} - -interface PhaseSeparatorProps { - leftColor: string; - rightColor: string; -} - -function PhaseSeparator({ leftColor, rightColor }: PhaseSeparatorProps) { - return ( -
- - - - -
- ); -} - -export interface TaskPhasesProps extends BoxProps { - taskSummary: any; -} - -export function TaskPhases({ taskSummary, ...boxProps }: TaskPhasesProps): JSX.Element { - const theme = useTheme(); - const phaseColors = getPhaseColors(theme); - - const phases = taskSummary.status.split('\n\n'); - const currentPhaseIdx = phases.findIndex((msg: string) => msg.startsWith('*')); - // probably don't need to memo for now because almost all renders will change its - // dependencies. - const phaseProps = phases.map((_: string, idx: number) => { - if ([RmfTaskSummary.STATE_CANCELED, RmfTaskSummary.STATE_FAILED].includes(taskSummary.state)) { - return { - className: classes.failedPhase, - color: phaseColors.failed, - }; - } - - if (taskSummary.state === RmfTaskSummary.STATE_COMPLETED) { - return { - className: classes.completedPhase, - color: phaseColors.completed, - }; - } - - if (taskSummary.state === RmfTaskSummary.STATE_ACTIVE && idx < currentPhaseIdx) { - return { - className: classes.completedPhase, - color: phaseColors.completed, - }; - } - - return { - className: classes.pendingPhase, - color: phaseColors.pending, - }; - }); - - return ( - - - {phases.map((phase: string, idx: number) => ( - - - {idx != phases.length - 1 && ( - - )} - - ))} - - - ); -} diff --git a/packages/react-components/lib/tasks/task-summary-accordion.spec.tsx b/packages/react-components/lib/tasks/task-summary-accordion.spec.tsx deleted file mode 100644 index ecd9b0493..000000000 --- a/packages/react-components/lib/tasks/task-summary-accordion.spec.tsx +++ /dev/null @@ -1,207 +0,0 @@ -import { act, render, waitForElementToBeRemoved } from '@testing-library/react'; -import userEvent from '@testing-library/user-event'; -import type { TaskSummary } from 'api-client'; -import React from 'react'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; -import { TaskSummaryAccordion, TaskSummaryAccordionInfo } from './task-summary-accordion'; -import { getActorFromStatus, sortTasks, sortTasksBySubmissionTime } from './task-summary-utils'; -import { makeTaskSummary } from './test-data.spec'; - -function getTaskObject(): Record { - // Returns a task object with a new memory allocation - return { - task1: makeTaskSummary({ - state: 1, - status: - 'Moving [tinyRobot/tinyRobot1]: ( 9.81228 -6.98942 -3.12904) -> ( 6.26403 -3.51569 1.16864) | Remaining phases: 1 | Remaining phases: 6', - submission_time: { sec: 0, nanosec: 500 }, - task_id: 'task1', - }), - task2: makeTaskSummary({ - state: 1, - status: - 'Moving [tinyRobot/tinyRobot2]: ( 9.81228 -6.98942 -3.12904) -> ( 6.26403 -3.51569 1.16864) | Remaining phases: 1 | Remaining phases: 6', - submission_time: { sec: 0, nanosec: 1000 }, - task_id: 'task2', - }), - task3: makeTaskSummary({ - state: 0, - status: - 'Moving [tinyRobot/tinyRobot3]: ( 9.81228 -6.98942 -3.12904) -> ( 6.26403 -3.51569 1.16864) | Remaining phases: 1 | Remaining phases: 6', - submission_time: { sec: 0, nanosec: 1500 }, - task_id: 'task3', - }), - }; -} - -describe('Renders correctly', () => { - let task: TaskSummary; - beforeEach(() => { - task = Object.values(getTaskObject())[0]; - }); - - it('Renders tree items', () => { - const tasks = Object.values(getTaskObject()); - const root = render(); - tasks.forEach((task) => { - expect(root.getByText(task.task_id).textContent).toBe(task.task_id); - }); - }); - - it('Show description below the id if the task has an actor', () => { - const root = render(); - const actor = getActorFromStatus(task.status); - if (!actor) throw new Error('An actor is required to run this test'); - const classes = root.getByText(actor[0]).className; - expect(classes).toContain('task-summary-accordion-task-actor'); - }); - - it('Does not show description below the id if the task has no actor', () => { - task.status = 'Finished'; - const root = render(); - expect(root.container.querySelector('[id=task-actor]')).toBeFalsy(); - }); -}); - -describe('Components gets the correct style on specifics states', () => { - let task: TaskSummary; - beforeEach(() => { - task = Object.values(getTaskObject())[0]; - }); - - it('Active style is applied ', () => { - task.state = RmfTaskSummary.STATE_ACTIVE; - const root = render(); - expect(root.getByText(task.task_id).parentElement?.className).toContain( - 'task-summary-accordion-active', - ); - }); - - it('Queue style is applied', () => { - task.state = RmfTaskSummary.STATE_QUEUED; - const root = render(); - expect(root.getByText(task.task_id).parentElement?.className).toContain( - 'task-summary-accordion-queued', - ); - }); - - it('Completed style is applied', () => { - task.state = RmfTaskSummary.STATE_COMPLETED; - const root = render(); - expect(root.getByText(task.task_id).parentElement?.className).toContain( - 'task-summary-accordion-completed', - ); - }); - - it('Failed style is applied', () => { - task.state = RmfTaskSummary.STATE_FAILED; - const root = render(); - expect(root.getByText(task.task_id).parentElement?.className).toContain( - 'task-summary-accordion-failed', - ); - }); -}); - -describe('Components gets the correct label on specifics states', () => { - let task: TaskSummary; - beforeEach(() => { - task = Object.values(getTaskObject())[0]; - }); - - it('Shows ACTIVE label', () => { - task.state = RmfTaskSummary.STATE_ACTIVE; - const root = render(); - expect(root.getByText('ACTIVE')).toBeTruthy(); - }); - - it('Shows QUEUE label', () => { - task.state = RmfTaskSummary.STATE_QUEUED; - const root = render(); - expect(root.getByText('QUEUED')).toBeTruthy(); - }); - - it('Shows COMPLETED label', () => { - task.state = RmfTaskSummary.STATE_COMPLETED; - const root = render(); - expect(root.getByText('COMPLETED')).toBeTruthy(); - }); - - it('Shows FAILED label', () => { - task.state = RmfTaskSummary.STATE_FAILED; - const root = render(); - expect(root.getByText('FAILED')).toBeTruthy(); - }); -}); - -describe('Sort Tasks', () => { - it('Sorts a task list by state correctly', () => { - const tasks = getTaskObject(); - tasks['test1'] = makeTaskSummary({ - state: 2, - status: 'test1', - submission_time: { sec: 0, nanosec: 0 }, - task_id: 'test1', - }); - tasks['test2'] = makeTaskSummary({ - state: 3, - status: 'test2', - submission_time: { sec: 0, nanosec: 0 }, - task_id: 'test2', - }); - const sortedTasks = sortTasks(tasks); - expect(sortedTasks[0].state).toBe(RmfTaskSummary.STATE_ACTIVE); - expect(sortedTasks[1].state).toBe(RmfTaskSummary.STATE_ACTIVE); - expect(sortedTasks[2].state).toBe(RmfTaskSummary.STATE_QUEUED); - expect(sortedTasks[3].state).toBe(RmfTaskSummary.STATE_FAILED); - expect(sortedTasks[4].state).toBe(RmfTaskSummary.STATE_COMPLETED); - }); - - it('Sorts a task list by submission time correctly', () => { - const tasks = Object.values(getTaskObject()); - const sortedTasks = sortTasksBySubmissionTime(tasks); - expect(sortedTasks[0].submission_time.nanosec).toBe(1500); - expect(sortedTasks[1].submission_time.nanosec).toBe(1000); - expect(sortedTasks[2].submission_time.nanosec).toBe(500); - }); - - it('Sorts a task list by state and submission time correctly', () => { - const sortedTasks = sortTasks(getTaskObject()); - expect(sortedTasks[0].task_id).toBe('task2'); - expect(sortedTasks[1].task_id).toBe('task1'); - expect(sortedTasks[2].task_id).toBe('task3'); - }); -}); - -describe('user interactions', () => { - let tasks: TaskSummary[]; - beforeEach(() => { - tasks = Object.values(getTaskObject()); - }); - - function getHeader(container: Element) { - return container.querySelector('.MuiTreeItem-content'); - } - - it('toggle expands when clicked', async () => { - const root = render(); - const header = getHeader(root.container)!; - expect(header).toBeTruthy(); - act(() => { - userEvent.click(header); - }); - expect(root.queryAllByRole('row', { hidden: false }).length).toBeTruthy(); - - act(() => { - userEvent.click(getHeader(root.container)!); - }); - await waitForElementToBeRemoved(() => root.queryAllByRole('row', { hidden: false }), { - timeout: 1000, - }); - }); -}); - -it('Gets the name of the actor from the status', () => { - const rawStatus = 'Finding a plan for [tinyRobot/tinyRobot1] to go to [23] | Remaining phases: 6'; - const actor = getActorFromStatus(rawStatus); - expect(actor).toEqual(['[tinyRobot/tinyRobot1]']); -}); diff --git a/packages/react-components/lib/tasks/task-summary-accordion.stories.tsx b/packages/react-components/lib/tasks/task-summary-accordion.stories.tsx deleted file mode 100644 index 9cb573e7a..000000000 --- a/packages/react-components/lib/tasks/task-summary-accordion.stories.tsx +++ /dev/null @@ -1,34 +0,0 @@ -import { Meta, Story } from '@storybook/react'; -import type { TaskSummary } from 'api-client'; -import React from 'react'; -import { TaskSummaryAccordion } from './task-summary-accordion'; -import { makeTaskSummary } from './test-data.spec'; - -const tasks: TaskSummary[] = [ - makeTaskSummary({ - state: 1, - status: - 'Moving [tinyRobot/tinyRobot1]: ( 9.81228 -6.98942 -3.12904) -> ( 6.26403 -3.51569 1.16864) | Remaining phases: 1 | Remaining phases: 6', - submission_time: { sec: 0, nanosec: 500 }, - task_id: '8b49e999-d246-4395-80f7-ebc5ca85e639', - }), - makeTaskSummary({ - end_time: { sec: 0, nanosec: 0 }, - start_time: { sec: 0, nanosec: 0 }, - state: 1, - status: - 'Moving [tinyRobot/tinyRobot2]: ( 9.81228 -6.98942 -3.12904) -> ( 6.26403 -3.51569 1.16864) | Remaining phases: 1 | Remaining phases: 6', - submission_time: { sec: 0, nanosec: 1000 }, - task_id: '82e73d4f-1da7-474a-91ce-34cc92532455', - }), -]; - -export default { - title: 'Task Summary Accordion', - component: TaskSummaryAccordion, - parameters: { actions: { argTypesRegex: '^on.*' } }, -} as Meta; - -export const TaskAccordion: Story = (args) => { - return ; -}; diff --git a/packages/react-components/lib/tasks/task-summary-accordion.tsx b/packages/react-components/lib/tasks/task-summary-accordion.tsx deleted file mode 100644 index 1aeb9be3c..000000000 --- a/packages/react-components/lib/tasks/task-summary-accordion.tsx +++ /dev/null @@ -1,214 +0,0 @@ -import React from 'react'; -import Debug from 'debug'; -// import type { TaskSummary } from 'api-client'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; -import { IconButton, Typography, styled } from '@mui/material'; -import { MultiSelectTreeViewProps, SingleSelectTreeViewProps, TreeItem, TreeView } from '@mui/lab'; -import ExpandMoreIcon from '@mui/icons-material/ExpandMore'; -import ChevronRightIcon from '@mui/icons-material/ChevronRight'; -import PlayCircleFilledWhiteIcon from '@mui/icons-material/PlayCircleFilledWhite'; -import PauseCircleFilledIcon from '@mui/icons-material/PauseCircleFilled'; -import { SimpleInfo, SimpleInfoData } from '../simple-info'; -import { formatStatus, getActorFromStatus, getStateLabel } from './task-summary-utils'; - -const debug = Debug('Tasks:TaskSummaryAccordion'); - -interface TaskSummaryAccordionInfoProps { - task: any; -} -interface TreeViewRootProps extends SingleSelectTreeViewProps { - onNodeToggle?: MultiSelectTreeViewProps['onNodeSelect']; -} - -const classes = { - root: 'task-summary-accordion-root', - accordionDetailLine: 'task-summary-accordion-accordion-detail-line', - treeChildren: 'task-summary-accordion-tree-children', - labelContent: 'task-summary-accordion-label-content', - expanded: 'task-summary-accordion-expanded', - completed: 'task-summary-accordion-completed', - queued: 'task-summary-accordion-queued', - active: 'task-summary-accordion-active', - failed: 'task-summary-accordion-failed', - taskActor: 'task-summary-accordion-task-actor', - overrideArrayItemValue: 'task-summary-accordion-override-array-item-value', - overrideContainer: 'task-summary-accordion-override-container', - overrideValue: 'task-summary-accordion-override-value', -}; -const StyledTreeView = styled((props: TreeViewRootProps) => )( - ({ theme }) => ({ - [`& .${classes.root}`]: { - padding: '1rem', - }, - [`& .${classes.accordionDetailLine}`]: { - display: 'flex', - justifyContent: 'space-between', - padding: theme.spacing(0.5), - }, - [`& .${classes.treeChildren}`]: { - margin: '0.5rem 0', - }, - [`& .${classes.labelContent}`]: { - padding: '0.5rem', - borderRadius: '0.5rem', - boxShadow: '0 0 25px 0 rgb(72, 94, 116, 0.3)', - overflowX: 'hidden', - display: 'flex', - flexDirection: 'column', - }, - [`& .${classes.expanded}`]: { - borderLeft: `0.1rem solid #cccccc`, - }, - [`& .${classes.completed}`]: { - backgroundColor: '#4E5453 !important', - }, - [`& .${classes.queued}`]: { - backgroundColor: theme.palette.warning.main + '!important', - }, - [`& .${classes.active}`]: { - backgroundColor: theme.palette.success.light + '!important', - }, - [`& .${classes.failed}`]: { - backgroundColor: theme.palette.error.main + '!important', - }, - [`& .${classes.taskActor}`]: { - alignSelf: 'center', - }, - [`& .${classes.overrideArrayItemValue}`]: { - textAlign: 'center', - }, - [`& .${classes.overrideContainer}`]: { - borderCollapse: 'collapse', - width: '100%', - overflowX: 'auto', - }, - [`& .${classes.overrideValue}`]: { - display: 'table-cell', - textAlign: 'end', - borderBottom: '1px solid', - borderBottomColor: theme.palette.divider, - borderTop: '1px solid', - borderTopColor: theme.palette.divider, - }, - }), -); - -export const TaskSummaryAccordionInfo = (props: TaskSummaryAccordionInfoProps): JSX.Element => { - const { task } = props; - const statusDetails = formatStatus(task.status); - const stateLabel = getStateLabel(task.state); - const data = [ - { name: 'TaskId', value: task.task_id, wrap: true }, - { name: 'State', value: stateLabel }, - { - name: 'Status', - value: statusDetails, - className: { - overrideValue: classes.overrideValue, - overrideArrayItemValue: classes.overrideArrayItemValue, - }, - }, - { name: 'Subm. Time', value: task.submission_time.sec }, - { name: 'Start time', value: task.start_time.sec }, - { name: 'End Time', value: task.end_time.sec }, - ] as SimpleInfoData[]; - - return ; -}; - -export interface TaskSummaryAccordionProps { - tasks: any[]; -} - -export const TaskSummaryAccordion = React.memo((props: TaskSummaryAccordionProps) => { - debug('task summary status panel render'); - const { tasks } = props; - const [expanded, setExpanded] = React.useState([]); - const [selected, setSelected] = React.useState(''); - - const handleToggle: MultiSelectTreeViewProps['onNodeSelect'] = (event, nodeIds) => { - setExpanded(nodeIds); - }; - - const handleSelect: SingleSelectTreeViewProps['onNodeSelect'] = (event, nodeIds) => { - setSelected(nodeIds); - }; - - const determineStyle = (state: number): string => { - switch (state) { - case RmfTaskSummary.STATE_QUEUED: - return classes.queued; - case RmfTaskSummary.STATE_ACTIVE: - return classes.active; - case RmfTaskSummary.STATE_COMPLETED: - return classes.completed; - case RmfTaskSummary.STATE_FAILED: - return classes.failed; - default: - return 'UNKNOWN'; - } - }; - - const renderActor = (taskStatus: string): React.ReactElement | null => { - const actor = getActorFromStatus(taskStatus); - if (!actor) return null; - return ( - - {actor} - - ); - }; - - const renderTaskTreeItem = (task: any) => { - return ( - - - {task.state === RmfTaskSummary.STATE_ACTIVE && ( - // TODO: add onClick with e.preventDefault() and with the pause plans logic. - - - - )} - {task.state === RmfTaskSummary.STATE_QUEUED && ( - - - - )} - {task.task_id} - - {renderActor(task.status)} - - } - > - - - ); - }; - - return ( - } - defaultExpanded={['root']} - defaultExpandIcon={} - expanded={expanded} - selected={selected} - > - {tasks.map((task) => renderTaskTreeItem(task))} - - ); -}); - -export default TaskSummaryAccordion; diff --git a/packages/react-components/lib/tasks/task-summary-utils.ts b/packages/react-components/lib/tasks/task-summary-utils.ts deleted file mode 100644 index f2b14567b..000000000 --- a/packages/react-components/lib/tasks/task-summary-utils.ts +++ /dev/null @@ -1,85 +0,0 @@ -// import type { TaskSummary } from 'api-client'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; - -// TODO: this is a hacky solution to get the actor from the task status, -// this should be changed when then backend sends an actor on the -// taskSummary message (we should use the actor provided by the message). -// https://github.com/osrf/rmf_core/issues/205 -export const getActorFromStatus = (status: string): RegExpMatchArray | null => { - // Gets the name of the robot if it has any - // eslint-disable-next-line - return status.match(/\[[A-Za-z]([a-zA-Z0-9\/]){3,}\]+/gi); -}; - -export const formatStatus = (status: string): string[] => { - return status.split('|'); -}; - -export const getStateLabel = (state: number): string => { - switch (state) { - case RmfTaskSummary.STATE_QUEUED: - return 'QUEUED'; - case RmfTaskSummary.STATE_ACTIVE: - return 'ACTIVE'; - case RmfTaskSummary.STATE_COMPLETED: - return 'COMPLETED'; - case RmfTaskSummary.STATE_FAILED: - return 'FAILED'; - default: - return 'UNKNOWN'; - } -}; - -export const sortTasksBySubmissionTime = (tasks: any[]): any[] => { - if (tasks.length === 0) return []; - return tasks.sort((a, b) => (a.submission_time.nanosec < b.submission_time.nanosec ? 1 : -1)); -}; - -/** - * Classifies and stores each task by its state. - */ -export const separateTasksByState = ( - tasks: Record, - states: string[], -): Record => { - const stateTasks: Record = {}; - states.forEach((state) => { - stateTasks[state] = []; - }); - - Object.keys(tasks).forEach((key) => { - switch (tasks[key].state) { - case RmfTaskSummary.STATE_QUEUED: - stateTasks.queued.push(tasks[key]); - break; - case RmfTaskSummary.STATE_ACTIVE: - stateTasks.active.push(tasks[key]); - break; - case RmfTaskSummary.STATE_COMPLETED: - stateTasks.completed.push(tasks[key]); - break; - case RmfTaskSummary.STATE_FAILED: - stateTasks.failed.push(tasks[key]); - break; - default: - stateTasks.unknown.push(tasks[key]); - break; - } - }); - return stateTasks; -}; - -/** - * Sort tasks by state and by submission time, so what is active is always at the top of the list. - */ -export const sortTasks = (tasks: Record): any[] => { - const states = ['active', 'queued', 'failed', 'completed', 'unknown']; - - const stateTasks = separateTasksByState(tasks, states); - const sortedTasks: any[] = []; - - states.forEach((state) => { - sortedTasks.push(...sortTasksBySubmissionTime(stateTasks[state])); - }); - return sortedTasks; -}; diff --git a/packages/react-components/lib/tasks/task-table.spec.tsx b/packages/react-components/lib/tasks/task-table.spec.tsx index f07aa780c..3d586701f 100644 --- a/packages/react-components/lib/tasks/task-table.spec.tsx +++ b/packages/react-components/lib/tasks/task-table.spec.tsx @@ -1,35 +1,13 @@ import { render } from '@testing-library/react'; import React from 'react'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; import { TaskTable } from './task-table'; -import { makeTaskSummaryWithPhases } from './test-data.spec'; +import { makeTaskState } from './test-data.spec'; describe('TaskTable', () => { it('shows all tasks', () => { - const tasks = [ - makeTaskSummaryWithPhases('task_0', 3, 3), - makeTaskSummaryWithPhases('task_1', 2, 2), - ]; + const tasks = [makeTaskState('task_0'), makeTaskState('task_1')]; const root = render(); root.getByText('task_0'); root.getByText('task_1'); }); - - it('smoke test for different task states', () => { - const activeTask = makeTaskSummaryWithPhases('active_task', 3, 3); - activeTask.state = RmfTaskSummary.STATE_ACTIVE; - const cancelledTask = makeTaskSummaryWithPhases('cancelled_task', 3, 3); - cancelledTask.state = RmfTaskSummary.STATE_CANCELED; - const completedTask = makeTaskSummaryWithPhases('completed_task', 3, 3); - completedTask.state = RmfTaskSummary.STATE_COMPLETED; - const failedTask = makeTaskSummaryWithPhases('failed_task', 3, 3); - failedTask.state = RmfTaskSummary.STATE_FAILED; - const pendingTask = makeTaskSummaryWithPhases('pending_task', 3, 3); - pendingTask.state = RmfTaskSummary.STATE_PENDING; - const queuedTask = makeTaskSummaryWithPhases('queuedTask', 3, 3); - queuedTask.state = RmfTaskSummary.STATE_QUEUED; - - const tasks = [activeTask, cancelledTask, completedTask, failedTask, pendingTask, queuedTask]; - render(); - }); }); diff --git a/packages/react-components/lib/tasks/task-table.stories.tsx b/packages/react-components/lib/tasks/task-table.stories.tsx index 8816aca81..784bc2cbe 100644 --- a/packages/react-components/lib/tasks/task-table.stories.tsx +++ b/packages/react-components/lib/tasks/task-table.stories.tsx @@ -1,33 +1,10 @@ import { Paper, TableContainer, TablePagination } from '@mui/material'; import { Meta, Story } from '@storybook/react'; import React from 'react'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; import { TaskTable, TaskTableProps } from './task-table'; -import { makeTaskSummaryWithPhases } from './test-data.spec'; +import { makeTaskState } from './test-data.spec'; -const failedTask = makeTaskSummaryWithPhases('failed_task', 3, 3); -failedTask.state = RmfTaskSummary.STATE_FAILED; - -const pendingTask = makeTaskSummaryWithPhases('pending_task', 3, 0); -pendingTask.state = RmfTaskSummary.STATE_PENDING; - -const queuedTask = makeTaskSummaryWithPhases('pending_task', 3, 0); -queuedTask.state = RmfTaskSummary.STATE_QUEUED; - -const completedtasks = Array.from(Array(100)).map((_, idx) => { - const task = makeTaskSummaryWithPhases(`completed_task_${idx}`, 3, 3); - task.state = RmfTaskSummary.STATE_COMPLETED; - return task; -}); - -const tasks = [ - makeTaskSummaryWithPhases('active_task', 3, 3), - makeTaskSummaryWithPhases('active_task_2', 4, 3), - failedTask, - pendingTask, - queuedTask, - ...completedtasks, -]; +const tasks = [makeTaskState('task_1'), makeTaskState('task_2'), makeTaskState('task_3')]; export default { title: 'Tasks/Table', diff --git a/packages/react-components/lib/tasks/task-table.tsx b/packages/react-components/lib/tasks/task-table.tsx index 8bb67d319..dce82f0fb 100644 --- a/packages/react-components/lib/tasks/task-table.tsx +++ b/packages/react-components/lib/tasks/task-table.tsx @@ -1,18 +1,15 @@ import { + styled, Table, TableBody, TableCell, TableHead, - TableRow, TableProps, - styled, + TableRow, } from '@mui/material'; -import type { TaskState, Time } from 'api-client'; +import { Status, TaskState } from 'api-client'; import clsx from 'clsx'; -import { formatDistanceToNow, format } from 'date-fns'; import React from 'react'; -import { rosTimeToJs } from '../utils'; -import { getState } from './utils'; const classes = { taskRowHover: 'task-table-taskrow-hover', @@ -63,10 +60,6 @@ const StyledTable = styled((props: TableProps) =>
)(({ theme backgroundColor: theme.palette.error.main, color: theme.palette.getContrastText(theme.palette.error.main), }, - [`& .${classes.taskPendingCell}`]: { - backgroundColor: theme.palette.info.dark, - color: theme.palette.getContrastText(theme.palette.info.light), - }, [`& .${classes.taskQueuedCell}`]: { backgroundColor: theme.palette.info.dark, color: theme.palette.getContrastText(theme.palette.info.light), @@ -86,14 +79,24 @@ function TaskRow({ task, onClick }: TaskRowProps) { // replace all temp info const [hover, setHover] = React.useState(false); - const returnTaskStateCellClass = (task: TaskState) => { - if (getState(task) === 'Underway') return classes.taskActiveCell; - if (getState(task) === 'Completed') return classes.taskCompletedCell; - return classes.taskUnknownCell; + const getTaskStateCellClass = (task: TaskState) => { + switch (task.status) { + case Status.Underway: + return classes.taskActiveCell; + case Status.Completed: + return classes.taskCompletedCell; + case Status.Canceled: + return classes.taskCancelledCell; + case Status.Failed: + return classes.taskFailedCell; + case Status.Queued: + return classes.taskQueuedCell; + default: + return classes.taskUnknownCell; + } }; - const taskStateCellClass = returnTaskStateCellClass(task); - // TODO - replace robot name with something else + const taskStateCellClass = getTaskStateCellClass(task); return ( <> setHover(true)} onMouseOut={() => setHover(false)} > + + {task.unix_millis_start_time + ? new Date(task.unix_millis_start_time).toLocaleDateString() + : 'unknown'} + {task.booking.id} - {'robotname'} + {task.assigned_to || 'unknown'} {task.unix_millis_start_time - ? format(new Date(task.unix_millis_start_time * 1000), 'dd - mm - yyyy') + ? new Date(task.unix_millis_start_time).toLocaleTimeString() : '-'} {task.unix_millis_finish_time - ? format(new Date(task.unix_millis_finish_time * 1000), 'dd - mm - yyyy') + ? new Date(task.unix_millis_finish_time).toLocaleTimeString() : '-'} - {task ? getState(task) : ''} + {task.status || 'unknown'} ); } -const toRelativeDate = (rosTime: Time) => { - return formatDistanceToNow(rosTimeToJs(rosTime), { addSuffix: true }); -}; - export interface TaskTableProps { /** * The current list of tasks to display, when pagination is enabled, this should only @@ -138,6 +142,7 @@ export function TaskTable({ tasks, onTaskClick }: TaskTableProps): JSX.Element { + Date Task Id Assignee Start Time diff --git a/packages/react-components/lib/tasks/task-timeline.spec.tsx b/packages/react-components/lib/tasks/task-timeline.spec.tsx index e9016a077..c96701b95 100644 --- a/packages/react-components/lib/tasks/task-timeline.spec.tsx +++ b/packages/react-components/lib/tasks/task-timeline.spec.tsx @@ -1,44 +1,29 @@ import { render } from '@testing-library/react'; import React from 'react'; -import { TaskSummary as RmfTaskSummary } from 'rmf-models'; -import { rosTimeToJs } from '../utils'; import { TaskTimeline } from './task-timeline'; -import { makeTaskSummaryWithPhases } from './test-data.spec'; +import { makeTaskState } from './test-data.spec'; describe('Task Timeline', () => { - it('shows the time', () => { - const task = makeTaskSummaryWithPhases('task_0', 2, 1); - const root = render(); - const expectedTime = rosTimeToJs(task.start_time).toLocaleTimeString(); - expect(root.getAllByText(expectedTime).length).toBeGreaterThan(0); - }); - - it('shows all task phases', () => { - const task = makeTaskSummaryWithPhases('task_0', 3, 3); - const root = render(); - expect(root.getByText(/Phase 1 test phase 1/i)).toBeTruthy(); - expect(root.getByText(/Phase 2 test phase 2/i)).toBeTruthy(); - expect(root.getByText(/Phase 3 test phase 3/i)).toBeTruthy(); + // FIXME: sample phases has no start time + xit('shows the time for each phase', () => { + const task = makeTaskState('task_0'); + const root = render(); + Object.values(task.phases).forEach((p) => { + expect(p.unix_millis_start_time).toBeTruthy(); + const expectedTime = new Date(p.unix_millis_start_time).toLocaleTimeString(); + expect(() => root.getByText(expectedTime)).not.toThrow(); + }); }); - it('smoke test for different task states', () => { - const activeTask = makeTaskSummaryWithPhases('active_task', 3, 3); - activeTask.state = RmfTaskSummary.STATE_ACTIVE; - const cancelledTask = makeTaskSummaryWithPhases('cancelled_task', 3, 3); - cancelledTask.state = RmfTaskSummary.STATE_CANCELED; - const completedTask = makeTaskSummaryWithPhases('completed_task', 3, 3); - completedTask.state = RmfTaskSummary.STATE_COMPLETED; - const failedTask = makeTaskSummaryWithPhases('failed_task', 3, 3); - failedTask.state = RmfTaskSummary.STATE_FAILED; - const pendingTask = makeTaskSummaryWithPhases('pending_task', 3, 3); - pendingTask.state = RmfTaskSummary.STATE_PENDING; - const queuedTask = makeTaskSummaryWithPhases('queuedTask', 3, 3); - queuedTask.state = RmfTaskSummary.STATE_QUEUED; - - const tasks = [activeTask, cancelledTask, completedTask, failedTask, pendingTask, queuedTask]; - const timelines = tasks.map((task, index) => { - render(); + it('shows all task events', () => { + const task = makeTaskState('task_0'); + const root = render(); + expect(task.phases).toBeTruthy(); + Object.values(task.phases).forEach((p) => { + if (!p.events) return; + Object.values(p.events).forEach((e) => { + expect(() => root.getByText(e.name)).toBeTruthy(); + }); }); - return timelines; }); }); diff --git a/packages/react-components/lib/tasks/task-timeline.stories.tsx b/packages/react-components/lib/tasks/task-timeline.stories.tsx index 4406ebbe9..266aba1b1 100644 --- a/packages/react-components/lib/tasks/task-timeline.stories.tsx +++ b/packages/react-components/lib/tasks/task-timeline.stories.tsx @@ -1,7 +1,7 @@ import { Meta, Story } from '@storybook/react'; import React from 'react'; import { TaskTimeline, TaskTimelineProps } from './task-timeline'; -import { TaskState } from 'api-client'; +import { makeTaskState } from './test-data.spec'; export default { title: 'Tasks/Timeline', @@ -11,47 +11,7 @@ export default { export const Timeline: Story = (args) => { return ; }; -const task: TaskState = { - active: 1, - booking: { id: 'Loop1', unix_millis_earliest_start_time: 7856, priority: null, labels: null }, - cancellation: null, - category: 'Loop', - completed: [], - detail: {}, - estimate_millis: 1076180, - interruptions: null, - killed: null, - pending: [2, 3], - phases: { - '1': { - category: 'Go to [place:pantry]', - detail: 'Moving the robot from [place:tinyRobot1_charger] to [place:pantry]', - estimate_millis: 9597, - events: null, - final_event_id: 0, - id: 1, - }, - '2': { - category: 'Go to [place:supplies]', - detail: 'Moving the robot from [place:pantry] to [place:supplies]', - estimate_millis: 9597, - events: null, - final_event_id: 0, - id: 2, - }, - '3': { - category: 'Go to [place:pantry]', - detail: 'Moving the robot from [place:supplies] to [place:pantry]', - estimate_millis: 9597, - events: null, - final_event_id: 0, - id: 3, - }, - }, - unix_millis_finish_time: null, - unix_millis_start_time: null, -}; Timeline.args = { - taskState: task, + taskState: makeTaskState('task'), }; diff --git a/packages/react-components/lib/tasks/task-timeline.tsx b/packages/react-components/lib/tasks/task-timeline.tsx index c1fc96639..2dfef041e 100644 --- a/packages/react-components/lib/tasks/task-timeline.tsx +++ b/packages/react-components/lib/tasks/task-timeline.tsx @@ -1,6 +1,5 @@ -import Paper from '@mui/material/Paper'; -import Typography from '@mui/material/Typography'; -import { styled } from '@mui/material'; +import ChevronRightIcon from '@mui/icons-material/ChevronRight'; +import ExpandMoreIcon from '@mui/icons-material/ExpandMore'; import { Timeline, TimelineConnector, @@ -8,17 +7,15 @@ import { TimelineDot, TimelineItem, TimelineOppositeContent, - TimelineSeparator, TimelineProps, - TreeView, + TimelineSeparator, TreeItem, + TreeView, } from '@mui/lab'; +import { styled } from '@mui/material'; +import Typography from '@mui/material/Typography'; import { TaskState } from 'api-client'; -import ExpandMoreIcon from '@mui/icons-material/ExpandMore'; -import ChevronRightIcon from '@mui/icons-material/ChevronRight'; import React from 'react'; -import { getTreeViewHeader } from './utils'; -import { format } from 'date-fns'; interface TimeLinePropsWithRef extends TimelineProps { ref?: React.RefObject; @@ -45,117 +42,53 @@ const StyledTimeLine = styled((props: TimeLinePropsWithRef) => { - // const estimateMillis = timelinePhases[p].estimate_millis; - // if (estimateMillis) totalTimeTaken += estimateMillis * 1000; - // }); - function getTimeLineDotProps(taskState: TaskState) { - if (taskState.active) return { className: classes.completedPhase }; - else { - return { className: classes.failedPhase }; - } - } - return timelinePhases ? ( - - - - {format(new Date(), "hh:mm aaaaa'm'")} - - - - - - - - } defaultExpandIcon={}> - - { - return ( - - {timelinePhases[phase].detail} - - ); - })} - /> - - - - - ) : null; -} - -function DeliveryTaskTree({ task }: TaskTreeProps) { - // TODO - get timeline dot props, get ingestor and dispenser information? - return ( - - - - {format(new Date(), "hh:mm aaaaa'm'")} - - - - - - - - } defaultExpandIcon={}> - - - - - - - ); -} - export interface TaskTimelineProps { taskState: TaskState; } export function TaskTimeline({ taskState }: TaskTimelineProps): JSX.Element { - // TODO - leaving here for reference for other treeviews - // function getTimeLineDotProps(taskState: TaskState, taskPhase: Phase) { - // if (taskState.completed?.includes(taskPhase.id)) return { className: classes.completedPhase }; - // if (taskPhase.id === taskState.active) return { className: classes.completedPhase }; - // if (taskState.pending?.includes(taskPhase.id)) return { className: classes.completedPhase }; - // else { - // return { className: classes.failedPhase }; - // } - // } - function GetTreeView(category: string) { - if (category.includes('Loop')) return ; - if (category.includes('Delivery')) return ; - } + const phases = taskState.phases ? Object.values(taskState.phases) : []; return ( - {taskState.category ? GetTreeView(taskState.category) : null} + {phases.map((phase, idx) => ( + + + + {phase.unix_millis_start_time + ? new Date(phase.unix_millis_start_time).toLocaleTimeString() + : 'unknown'} + + + + + {idx < phases.length - 1 && } + + + } + defaultExpandIcon={} + > + {/* FIXME: rmf does not return event hierarchy information */} + {phase.events + ? Object.values(phase.events).map((event) => ( + + )) + : null} + + + + ))} ); } diff --git a/packages/react-components/lib/tasks/test-data.spec.ts b/packages/react-components/lib/tasks/test-data.spec.ts index daa7358ee..70c67816b 100644 --- a/packages/react-components/lib/tasks/test-data.spec.ts +++ b/packages/react-components/lib/tasks/test-data.spec.ts @@ -1,244 +1,548 @@ -import type { - Clean, - Delivery, - Loop, - Station, - SubmitTask, - Task, - TaskDescription, - TaskProfile, - TaskSummary, -} from 'api-client'; -import { TaskSummary as RmfTaskSummary, TaskType as RmfTaskType } from 'rmf-models'; +import type { TaskEventLog, TaskState } from 'api-client'; -const baseCleanDesc: Clean = { - start_waypoint: '', -}; - -export function makeClean(clean: Partial = {}): Clean { - return { ...baseCleanDesc, ...clean }; -} - -const baseDeliveryDesc: Delivery = { - task_id: '', - pickup_behavior: { - name: '', - parameters: [], - }, - pickup_dispenser: '', - pickup_place_name: '', - dropoff_behavior: { - name: '', - parameters: [], - }, - dropoff_ingestor: '', - dropoff_place_name: '', - items: [], -}; - -export function makeDelivery(delivery: Partial = {}): Delivery { - return { ...baseDeliveryDesc, ...delivery }; -} - -const baseLoopDesc: Loop = { - task_id: '', - start_name: '', - finish_name: '', - num_loops: 0, - robot_type: '', -}; - -export function makeLoop(loop: Partial = {}): Loop { - return { ...baseLoopDesc, ...loop }; -} - -const baseStationDesc: Station = { - task_id: '', - place_name: '', - robot_type: '', -}; - -export function makeStation(station: Partial = {}): Station { - return { ...baseStationDesc, ...station }; -} - -const baseTaskDescription: TaskDescription = { - clean: baseCleanDesc, - delivery: baseDeliveryDesc, - loop: baseLoopDesc, - station: baseStationDesc, - task_type: { type: 0 }, - priority: { value: 0 }, - start_time: { sec: 0, nanosec: 0 }, -}; - -export function makeTaskDescription( - taskDescription: Partial = {}, -): TaskDescription { - return { ...baseTaskDescription, ...taskDescription }; -} - -const baseTaskProfile: TaskProfile = { - task_id: '', - submission_time: { sec: 0, nanosec: 0 }, - description: baseTaskDescription, -}; - -export function makeTaskProfile(taskProfile: Partial = {}): TaskProfile { - return { - ...baseTaskProfile, - ...taskProfile, - }; -} - -const baseTaskSummary: TaskSummary = { - task_id: '', - fleet_name: '', - robot_name: '', - task_profile: baseTaskProfile, - end_time: { sec: 0, nanosec: 0 }, - start_time: { sec: 0, nanosec: 0 }, - state: 1, - status: '', - submission_time: { sec: 0, nanosec: 0 }, -}; - -export function makeTaskSummary(taskSummary: Partial = {}): TaskSummary { - return { - ...baseTaskSummary, - ...taskSummary, - }; -} - -export function makeTaskSummaryWithPhases( - id: string, - numberOfPhases: number, - currentPhase: number, -): TaskSummary { - let status = ''; - for (let i = 0; i < numberOfPhases; i++) { - if (currentPhase === i + 1) { - status += '*'; - } - status += `Phase ${i + 1}\ntest phase ${i + 1}\n\n`; - } - status = status.trimEnd(); - return makeTaskSummary({ - task_id: id, - state: RmfTaskSummary.STATE_ACTIVE, - status: status, - fleet_name: 'test_fleet', - robot_name: 'test_robot', - }); -} - -export function makeSubmitTask(): SubmitTask { - return { - description: { - cleaning_zone: 'zone', +export function makeTaskState(taskId: string): TaskState { + const state = JSON.parse(`{ + "booking": { + "id": "delivery_2021:11:08:23:50", + "unix_millis_earliest_start_time": 1636388400000, + "priority": "none", + "automatic": false }, - start_time: Math.floor(Date.now() / 1000), - task_type: RmfTaskType.TYPE_CLEAN, - priority: 0, - }; -} - -export function makeDefinedTask( - type: string, - robotName: string, - id: string, - numberOfPhases: number, - currentPhase: number, -): Task { - let status = ''; - for (let i = 0; i < numberOfPhases; i++) { - if (currentPhase === i + 1) { - status += '*'; - } - status += `Phase ${i + 1}\ntest phase ${i + 1}\n\n`; + "category": "Multi-Delivery", + "detail": [ + { + "category": "Pick Up", + "params": { + "location": "Kitchen", + "items": [ + { + "type": "soda", + "quantity": 1 + }, + { + "type": "water", + "quantity": 1 + } + ] + } + }, + { + "category": "Drop Off", + "params": { + "location": "room_203", + "items": [ + { + "type": "soda", + "quantity": 1 + } + ] + } + }, + { + "category": "Drop Off", + "params": { + "location": "room_521", + "items": [ + { + "type": "water", + "quantity": 1 + } + ] + } + } + ], + "unix_millis_start_time": 1636388410000, + "estimate_millis": 2000000, + "phases": { + "1": { + "id": 1, + "category": "Pick Up", + "detail": { + "location": "Kitchen", + "items": [ + { + "type": "soda", + "quantity": 1 + }, + { + "type": "water", + "quantity": 1 + } + ] + }, + "estimate_millis": 600000, + "final_event_id": 0, + "events": { + "0": { + "id": 0, + "status": "completed", + "name": "Pick Up Sequence", + "detail": "", + "deps": [1, 2] + }, + "1": { + "id": 1, + "status": "completed", + "name": "Go to [place:kitchen]", + "detail": "", + "deps": [3, 4, 8] + }, + "2": { + "id": 2, + "status": "completed", + "name": "Receive items", + "detail": [ + { + "type": "soda", + "quantity": 1 + }, + { + "type": "water", + "quantity": 1 + } + ], + "deps": [] + }, + "3": { + "id": 3, + "status": "completed", + "name": "Move to [place:kitchen_door_exterior]", + "detail": "", + "deps": [] + }, + "4": { + "id": 4, + "status": "completed", + "name": "Pass through [door:kitchen_door]", + "detail": "", + "deps": [5, 6, 7] + }, + "5": { + "id": 5, + "status": "completed", + "name": "Wait for [door:kitchen_door] to open", + "detail": "", + "deps": [] + }, + "6": { + "id": 6, + "status": "completed", + "name": "Move to [place:kitchen_door_interior]", + "detail": "", + "deps": [] + }, + "7": { + "id": 7, + "status": "completed", + "name": "Wait for [door:kitchen_door] to close", + "detail": "", + "deps": [] + }, + "8": { + "id": 8, + "status": "completed", + "name": "Move to [place:kitchen]", + "detail": "", + "deps": [] + } + } + }, + "2": { + "id": 2, + "category": "Drop Off", + "detail": { + "location": "room_203", + "items": [ + { + "type": "soda", + "quantity": 1 + } + ] + }, + "estimate_millis": 720000, + "final_event_id": 0, + "events": { + "0": { + "id": 0, + "status": "underway", + "name": "Drop Off Sequence", + "detail": "", + "deps": [1, 2] + }, + "1": { + "id": 1, + "status": "underway", + "name": "Go to [place:room_203]", + "detail": "", + "deps": [3, 4, 8, 9, 14] + }, + "2": { + "id": 2, + "status": "standby", + "name": "Unload items", + "detail": [ + { + "type": "soda", + "quantity": 1 + } + ], + "deps": [] + }, + "3": { + "id": 3, + "status": "completed", + "name": "Move to [place:kitchen_door_interior]", + "detail": "", + "deps": [] + }, + "4": { + "id": 4, + "status": "underway", + "name": "Pass through [door:kitchen_door]", + "detail": "", + "deps": [5, 6, 7] + }, + "5": { + "id": 5, + "status": "underway", + "name": "Wait for [door:kitchen_door] to open", + "detail": "", + "deps": [] + }, + "6": { + "id": 6, + "status": "standby", + "name": "Move to [place:kitchen_door_exterior]", + "detail": "", + "deps": [] + }, + "7": { + "id": 7, + "status": "standby", + "name": "Wait for [door:kitchen_door] to close", + "detail": "", + "deps": [] + }, + "8": { + "id": 8, + "status": "standby", + "name": "Move to [place:lift_lobby_05_floor_B1]", + "detail": "", + "deps": [] + }, + "9": { + "id": 9, + "status": "standby", + "name": "Take [lift:lift_05_03] to [place:lift_lobby_05_floor_L2]", + "detail": "", + "deps": [10, 11, 12, 13] + }, + "10": { + "id": 10, + "status": "underway", + "name": "Wait for lift", + "detail": "Currently assigned [lift:lift_05_03]", + "deps": [] + }, + "11": { + "id": 11, + "status": "standby", + "name": "Move to [place:lift_05_03_floor_B1]", + "detail": "", + "deps": [] + }, + "12": { + "id": 12, + "status": "standby", + "name": "Lift [lift:lift_05_03] to [place:lift_05_03_floor_2]", + "detail": "", + "deps": [] + }, + "13": { + "id": 13, + "status": "standby", + "name": "Wait for [lift:lift_05_03] to open", + "detail": "", + "deps": [] + }, + "14": { + "id": 14, + "status": "standby", + "name": "Move to [place:room_203]", + "detail": "", + "deps": [] + } + } + }, + "3": { + "id": 3, + "category": "Drop Off", + "detail": { + "location": "room_521", + "items": [ + { + "type": "water", + "quantity": 1 + } + ] + }, + "estimate_millis": 680000 + } + }, + "completed": [ 1 ], + "active": 2, + "pending": [ 3 ] } - status = status.trimEnd(); - - const loop = makeLoop({ - task_id: id, - robot_type: 'test_robot', - num_loops: 1, - start_name: 'loop_location_1', - finish_name: 'loop_location_2', - }); - - const loopTask = makeTaskDescription({ - start_time: { sec: 0, nanosec: 0 }, - priority: { value: 0 }, - task_type: { type: 1 }, - loop: loop, - }); - - const delivery = makeDelivery({ - task_id: id, - items: [], - pickup_place_name: 'pickup_1', - pickup_dispenser: 'pickup_dispenser', - dropoff_place_name: 'dropoff_1', - dropoff_ingestor: 'dropoff_ingesstor', - }); - - const deliveryTask = makeTaskDescription({ - start_time: { sec: 0, nanosec: 0 }, - priority: { value: 0 }, - task_type: { type: 2 }, - delivery: delivery, - }); - - const clean = makeClean({ - start_waypoint: 'cleaning_zone', - }); - - const cleaningTask = makeTaskDescription({ - start_time: { sec: 0, nanosec: 0 }, - priority: { value: 0 }, - task_type: { type: 4 }, - clean: clean, - }); - - function checkType() { - switch (type) { - case 'Delivery': - return deliveryTask; - - case 'Loop': - return loopTask; - - case 'Clean': - return cleaningTask; + `); + state.booking.id = taskId; + return state; +} - default: - return loopTask; +export function makeTaskLog(taskId: string): TaskEventLog { + const log = JSON.parse(`{ + "task_id": "delivery_2021:11:08:23:50", + "log": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388410000, + "text": "Beginning task" + } + ], + "phases": { + "1": { + "log": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388410000, + "text": "Beginning phase" + } + ], + "events": { + "1": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388409995, + "text": "Generating plan to get from [place:parking_03] to [place:kitchen]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388409996, + "text": "Finished generating plan to get from [place:parking_03] to [place:kitchen]" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388414500, + "text": "Finished: Move to [place:kitchen_door_exterior]" + }, + { + "seq": 3, + "tier": "info", + "unix_millis_time": 1636388415000, + "text": "Finished: Wait for [door:kitchen_door] to open" + }, + { + "seq": 4, + "tier": "info", + "unix_millis_time": 1636388418001, + "text": "Finished: Move to [place:kitchen_door_interior]" + }, + { + "seq": 5, + "tier": "info", + "unix_millis_time": 1636388419111, + "text": "Finished: Wait for [door:kitchen_door] to close" + }, + { + "seq": 6, + "tier": "info", + "unix_millis_time": 1636388421121, + "text": "Finished: Move to [place:kitchen]" + } + ], + "2": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388421421, + "text": "Requested [item:soda], [item:water]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388421521, + "text": "Request acknowledged" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388430000, + "text": "Received [item:soda]" + }, + { + "seq": 3, + "tier": "info", + "unix_millis_time": 1636388440000, + "text": "Received [item:water]" + } + ], + "3": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388410000, + "text": "Moving towards [place:kitchen_door_exterior] from [place:parking_03]" + }, + { + "seq": 1, + "tier": "warning", + "unix_millis_time": 1636388411000, + "text": "Delayed by obstacle blocking [robot:deliverbot_01]" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388414500, + "text": "Arrived at [place:kitchen_door_exterior]" + } + ], + "5": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388414500, + "text": "Requested [door:kitchen_door] to open" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388414600, + "text": "[door:kitchen_door] acknowledged request" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388415000, + "text": "[door:kitchen_door] has opened" + } + ], + "6": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388415010, + "text": "Moving towards [place:kitchen_door_interior] from [place:kitchen_door_exterior]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388418000, + "text": "Arrived at [place:kitchen_door_interior]" + } + ], + "7": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388418010, + "text": "Requested [door:kitchen_door] to close" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388418110, + "text": "[door:kitchen_door] acknowledged request" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388419110, + "text": "[door:kitchen] has closed" + } + ], + "8": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388419120, + "text": "Moving towards [place:kitchen] from [place:kitchen_door_interior]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388421120, + "text": "Arrived at [place:kitchen]" + } + ] + } + }, + "2": { + "log": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388444500, + "text": "Beginning phase" + } + ], + "events": { + "1": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388440000, + "text": "Generating plan to get from [place:kitchen] to [place:room_203]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388440010, + "text": "Finished generating plan to get from [place:kitchen_03] to [place:room_203]" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388450000, + "text": "Finished: Move to [place:kitchen_door_interior]" + } + ], + "3": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388440010, + "text": "Moving towards [place:kitchen_door_interior] from [place:kitchen]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388450000, + "text": "Arrived at [place:kitchen_door_interior]" + } + ], + "5": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388450010, + "text": "Requested [door:kitchen_door] to open" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388450110, + "text": "[door:kitchen_door] acknowledged request" + } + ] + } + } } } - - const taskSummary = makeTaskSummary({ - task_id: id, - task_profile: { - task_id: id, - submission_time: { sec: 0, nanosec: 0 }, - description: checkType(), - }, - start_time: { sec: 0, nanosec: 0 }, - end_time: { sec: 0, nanosec: 0 }, - submission_time: { sec: 0, nanosec: 0 }, - state: RmfTaskSummary.STATE_ACTIVE, - status: status, - fleet_name: 'test_fleet', - robot_name: robotName, - }); - - const progress = `${Math.floor(Math.random() * 100)}%`; - - return { - task_id: id, - authz_grp: 'test_group', - summary: taskSummary, - progress: { status: `${progress}%` }, - }; + `); + log.task_id = taskId; + return log; } diff --git a/packages/react-components/lib/tasks/utils.ts b/packages/react-components/lib/tasks/utils.ts index cd2b766c7..a86b41e20 100644 --- a/packages/react-components/lib/tasks/utils.ts +++ b/packages/react-components/lib/tasks/utils.ts @@ -53,25 +53,3 @@ export function parseTaskDetail(task: TaskState, category?: string) { return {}; } } - -export function getState(task: TaskState) { - // TODO - handle killed and cancelled states - if (task.phases && task.completed?.length === Object.keys(task.phases).length) return 'Completed'; - if (task.active) return 'Underway'; - return ''; -} - -export function getTreeViewHeader(category: TaskState['category']) { - switch (category) { - case 'Loop': - return 'Loop Sequence'; - case 'Clean': - return 'Clean Sequence'; - case 'Delivery': - // TODO - not sure about return structure, - // once able to receive delivery task - // come back again. - default: - return ''; - } -} From e5a271131cc04b5486f31134777fc73a1bc06e1f Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 19 Jan 2022 05:39:07 +0000 Subject: [PATCH 36/79] update models Signed-off-by: Teo Koon Peng --- packages/api-client/lib/openapi/api.ts | 1606 +++++++++++++++++++++--- packages/api-client/lib/version.ts | 2 +- 2 files changed, 1458 insertions(+), 150 deletions(-) diff --git a/packages/api-client/lib/openapi/api.ts b/packages/api-client/lib/openapi/api.ts index ccfbfd0ec..ee4496fcb 100644 --- a/packages/api-client/lib/openapi/api.ts +++ b/packages/api-client/lib/openapi/api.ts @@ -31,6 +31,57 @@ import { // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; +/** + * + * @export + * @interface Activity + */ +export interface Activity { + /** + * The category of this activity. There must not be any duplicate activity categories per fleet. + * @type {string} + * @memberof Activity + */ + category: string; + /** + * Details about the behavior of the activity. + * @type {string} + * @memberof Activity + */ + detail: string; + /** + * The schema for this activity description + * @type {object} + * @memberof Activity + */ + description_schema?: object; +} +/** + * + * @export + * @interface ActivityDiscovery + */ +export interface ActivityDiscovery { + /** + * + * @type {Array} + * @memberof ActivityDiscovery + */ + data?: Array; +} +/** + * + * @export + * @interface ActivityDiscoveryRequest + */ +export interface ActivityDiscoveryRequest { + /** + * Indicate that this is an activity discovery request + * @type {string} + * @memberof ActivityDiscoveryRequest + */ + type: string; +} /** * * @export @@ -218,6 +269,44 @@ export interface Cancellation { */ labels: Array; } +/** + * + * @export + * @interface Data + */ +export interface Data { + /** + * Name of the fleet that supports these tasks + * @type {string} + * @memberof Data + */ + fleet_name?: string; + /** + * (list:replace) List of tasks that the fleet supports + * @type {Array} + * @memberof Data + */ + tasks?: Array; +} +/** + * + * @export + * @interface Datum + */ +export interface Datum { + /** + * Name of the fleet that supports these activities + * @type {string} + * @memberof Datum + */ + fleet_name: string; + /** + * List of activities that the fleet supports + * @type {Array} + * @memberof Datum + */ + activities: Array; +} /** * Detailed information about a task, phase, or event * @export @@ -249,6 +338,25 @@ export interface Dispatch { */ errors?: Array; } +/** + * + * @export + * @interface DispatchTaskRequest + */ +export interface DispatchTaskRequest { + /** + * Indicate that this is a task dispatch request + * @type {string} + * @memberof DispatchTaskRequest + */ + type: string; + /** + * + * @type {TaskRequest} + * @memberof DispatchTaskRequest + */ + request: TaskRequest; +} /** * * @export @@ -1474,6 +1582,31 @@ export interface SkipPhaseRequest { */ undo?: Undo; } +/** + * Response to a request for a phase to be skipped + * @export + * @interface SkipPhaseResponse + */ +export interface SkipPhaseResponse { + /** + * The request failed + * @type {boolean} + * @memberof SkipPhaseResponse + */ + success: boolean; + /** + * A token for the request. The value of this token is unique within the scope of this request and can be used by other requests to reference this request. + * @type {string} + * @memberof SkipPhaseResponse + */ + token: string; + /** + * Any error messages explaining why the request failed. + * @type {Array} + * @memberof SkipPhaseResponse + */ + errors: Array; +} /** * An enumeration. * @export @@ -1525,6 +1658,31 @@ export enum Status2 { Error = 'error', } +/** + * + * @export + * @interface Task + */ +export interface Task { + /** + * The category of this task. There must not be any duplicate task categories per fleet. + * @type {string} + * @memberof Task + */ + category: string; + /** + * Details about the behavior of the task. + * @type {string} + * @memberof Task + */ + detail: string; + /** + * The schema for this task description + * @type {object} + * @memberof Task + */ + description_schema?: object; +} /** * Response to a request to cancel a task * @export @@ -1544,6 +1702,101 @@ export interface TaskCancelResponse { */ errors: Array; } +/** + * + * @export + * @interface TaskDiscovery + */ +export interface TaskDiscovery { + /** + * Indicate that this is an task discovery update + * @type {string} + * @memberof TaskDiscovery + */ + type?: string; + /** + * + * @type {Data} + * @memberof TaskDiscovery + */ + data?: Data; +} +/** + * + * @export + * @interface TaskDiscoveryRequest + */ +export interface TaskDiscoveryRequest { + /** + * Indicate that this is a task discovery request + * @type {string} + * @memberof TaskDiscoveryRequest + */ + type: string; +} +/** + * Response to a task dispatch request + * @export + * @interface TaskDispatchResponse + */ +export interface TaskDispatchResponse { + /** + * + * @type {boolean} + * @memberof TaskDispatchResponse + */ + success: boolean; + /** + * + * @type {TaskState} + * @memberof TaskDispatchResponse + */ + state?: TaskState; + /** + * Any error messages explaining why the request failed + * @type {Array} + * @memberof TaskDispatchResponse + */ + errors?: Array; +} +/** + * + * @export + * @interface TaskDispatchResponseItem + */ +export interface TaskDispatchResponseItem { + /** + * + * @type {boolean} + * @memberof TaskDispatchResponseItem + */ + success: boolean; + /** + * + * @type {TaskState} + * @memberof TaskDispatchResponseItem + */ + state?: TaskState; +} +/** + * + * @export + * @interface TaskDispatchResponseItem1 + */ +export interface TaskDispatchResponseItem1 { + /** + * + * @type {boolean} + * @memberof TaskDispatchResponseItem1 + */ + success?: boolean; + /** + * Any error messages explaining why the request failed + * @type {Array} + * @memberof TaskDispatchResponseItem1 + */ + errors?: Array; +} /** * * @export @@ -1569,6 +1822,131 @@ export interface TaskEventLog { */ phases?: { [key: string]: Phases }; } +/** + * + * @export + * @interface TaskInterruptionRequest + */ +export interface TaskInterruptionRequest { + /** + * Indicate that this is a task interruption request + * @type {string} + * @memberof TaskInterruptionRequest + */ + type: string; + /** + * Specify the task ID to interrupt + * @type {string} + * @memberof TaskInterruptionRequest + */ + task_id: string; + /** + * Labels to describe the purpose of the interruption + * @type {Array} + * @memberof TaskInterruptionRequest + */ + labels?: Array; +} +/** + * Response to a request for a task to be interrupted + * @export + * @interface TaskInterruptionResponse + */ +export interface TaskInterruptionResponse { + /** + * The request failed + * @type {boolean} + * @memberof TaskInterruptionResponse + */ + success: boolean; + /** + * A token for the request. The value of this token is unique within the scope of this request and can be used by other requests to reference this request. + * @type {string} + * @memberof TaskInterruptionResponse + */ + token: string; + /** + * Any error messages explaining why the request failed. + * @type {Array} + * @memberof TaskInterruptionResponse + */ + errors: Array; +} +/** + * + * @export + * @interface TaskKillRequest + */ +export interface TaskKillRequest { + /** + * Indicate that this is a task kill request + * @type {string} + * @memberof TaskKillRequest + */ + type: string; + /** + * Specify the task ID to kill + * @type {string} + * @memberof TaskKillRequest + */ + task_id: string; + /** + * Labels to describe the purpose of the kill + * @type {Array} + * @memberof TaskKillRequest + */ + labels?: Array; +} +/** + * Response to a request to kill a task + * @export + * @interface TaskKillResponse + */ +export interface TaskKillResponse { + /** + * The request failed + * @type {boolean} + * @memberof TaskKillResponse + */ + success: boolean; + /** + * If the request failed, these error messages will explain why + * @type {Array} + * @memberof TaskKillResponse + */ + errors: Array; +} +/** + * + * @export + * @interface TaskPhaseSkipRequest + */ +export interface TaskPhaseSkipRequest { + /** + * Indicate that this is a phase skip request + * @type {string} + * @memberof TaskPhaseSkipRequest + */ + type: string; + /** + * Specify the task ID whose phase should be skipped + * @type {string} + * @memberof TaskPhaseSkipRequest + */ + task_id: string; + /** + * Specify the phase that should be skipped + * @type {number} + * @memberof TaskPhaseSkipRequest + */ + phase_id: number; + /** + * Labels to describe the purpose of the skip + * @type {Array} + * @memberof TaskPhaseSkipRequest + */ + labels?: Array; +} /** * * @export @@ -1609,25 +1987,119 @@ export interface TaskRequest { /** * * @export - * @interface TaskState + * @interface TaskResumeRequest */ -export interface TaskState { +export interface TaskResumeRequest { /** - * - * @type {Booking} - * @memberof TaskState + * Indicate that this is a task resuming request + * @type {string} + * @memberof TaskResumeRequest */ - booking: Booking; + type?: string; /** - * The category of this task or phase + * Specify task ID to resume. * @type {string} - * @memberof TaskState + * @memberof TaskResumeRequest */ - category?: string; + for_task?: string; /** - * - * @type {Detail} - * @memberof TaskState + * A list of tokens of interruption requests which should be resumed. The interruption request associated with each token will be discarded. + * @type {Array} + * @memberof TaskResumeRequest + */ + for_tokens?: Array; + /** + * Labels describing this request + * @type {Array} + * @memberof TaskResumeRequest + */ + labels?: Array; +} +/** + * Response to a request to resume a task + * @export + * @interface TaskResumeResponse + */ +export interface TaskResumeResponse { + /** + * The request failed + * @type {boolean} + * @memberof TaskResumeResponse + */ + success: boolean; + /** + * If the request failed, these error messages will explain why + * @type {Array} + * @memberof TaskResumeResponse + */ + errors: Array; +} +/** + * + * @export + * @interface TaskRewindRequest + */ +export interface TaskRewindRequest { + /** + * Indicate that this is a task rewind request + * @type {string} + * @memberof TaskRewindRequest + */ + type: string; + /** + * Specify the ID of the task that should rewind + * @type {string} + * @memberof TaskRewindRequest + */ + task_id: string; + /** + * Specify the phase that should be rewound to. The task will restart at the beginning of this phase. + * @type {number} + * @memberof TaskRewindRequest + */ + phase_id: number; +} +/** + * Response to a request to rewind a task + * @export + * @interface TaskRewindResponse + */ +export interface TaskRewindResponse { + /** + * The request failed + * @type {boolean} + * @memberof TaskRewindResponse + */ + success: boolean; + /** + * If the request failed, these error messages will explain why + * @type {Array} + * @memberof TaskRewindResponse + */ + errors: Array; +} +/** + * + * @export + * @interface TaskState + */ +export interface TaskState { + /** + * + * @type {Booking} + * @memberof TaskState + */ + booking: Booking; + /** + * The category of this task or phase + * @type {string} + * @memberof TaskState + */ + category?: string; + /** + * + * @type {Detail} + * @memberof TaskState */ detail?: Detail; /** @@ -1747,6 +2219,69 @@ export interface Time { */ nanosec: number; } +/** + * Template for defining a response message that provides a token upon success or errors upon failure + * @export + * @interface TokenResponse + */ +export interface TokenResponse { + /** + * The request failed + * @type {boolean} + * @memberof TokenResponse + */ + success: boolean; + /** + * A token for the request. The value of this token is unique within the scope of this request and can be used by other requests to reference this request. + * @type {string} + * @memberof TokenResponse + */ + token: string; + /** + * Any error messages explaining why the request failed. + * @type {Array} + * @memberof TokenResponse + */ + errors: Array; +} +/** + * + * @export + * @interface TokenResponseItem + */ +export interface TokenResponseItem { + /** + * The request was successful + * @type {boolean} + * @memberof TokenResponseItem + */ + success: boolean; + /** + * A token for the request. The value of this token is unique within the scope of this request and can be used by other requests to reference this request. + * @type {string} + * @memberof TokenResponseItem + */ + token: string; +} +/** + * + * @export + * @interface TokenResponseItem1 + */ +export interface TokenResponseItem1 { + /** + * The request failed + * @type {boolean} + * @memberof TokenResponseItem1 + */ + success: boolean; + /** + * Any error messages explaining why the request failed. + * @type {Array} + * @memberof TokenResponseItem1 + */ + errors: Array; +} /** * * @export @@ -1766,6 +2301,56 @@ export interface Undo { */ labels: Array; } +/** + * + * @export + * @interface UndoPhaseSkipRequest + */ +export interface UndoPhaseSkipRequest { + /** + * Indicate that this is a request to undo a phase skip request + * @type {string} + * @memberof UndoPhaseSkipRequest + */ + type?: string; + /** + * Specify the relevant task ID + * @type {string} + * @memberof UndoPhaseSkipRequest + */ + for_task?: string; + /** + * A list of the tokens of skip requests which should be undone. The skips associated with each token will be discarded. + * @type {Array} + * @memberof UndoPhaseSkipRequest + */ + for_tokens?: Array; + /** + * Labels describing this request + * @type {Array} + * @memberof UndoPhaseSkipRequest + */ + labels?: Array; +} +/** + * Response to an undo phase skip request + * @export + * @interface UndoPhaseSkipResponse + */ +export interface UndoPhaseSkipResponse { + /** + * The request failed + * @type {boolean} + * @memberof UndoPhaseSkipResponse + */ + success: boolean; + /** + * If the request failed, these error messages will explain why + * @type {Array} + * @memberof UndoPhaseSkipResponse + */ + errors: Array; +} /** * * @export @@ -4343,21 +4928,11 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio }, /** * - * @summary Query Fleets - * @param {string} [fleetName] comma separated list of fleet names - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * @summary Get Fleets * @param {*} [options] Override http request option. * @throws {RequiredError} */ - queryFleetsFleetsGet: async ( - fleetName?: string, - limit?: number, - offset?: number, - orderBy?: string, - options: any = {}, - ): Promise => { + getFleetsFleetsGet: async (options: any = {}): Promise => { const localVarPath = `/fleets`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -4370,22 +4945,6 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (fleetName !== undefined) { - localVarQueryParameter['fleet_name'] = fleetName; - } - - if (limit !== undefined) { - localVarQueryParameter['limit'] = limit; - } - - if (offset !== undefined) { - localVarQueryParameter['offset'] = offset; - } - - if (orderBy !== undefined) { - localVarQueryParameter['order_by'] = orderBy; - } - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { @@ -4448,28 +5007,14 @@ export const FleetsApiFp = function (configuration?: Configuration) { }, /** * - * @summary Query Fleets - * @param {string} [fleetName] comma separated list of fleet names - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * @summary Get Fleets * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async queryFleetsFleetsGet( - fleetName?: string, - limit?: number, - offset?: number, - orderBy?: string, + async getFleetsFleetsGet( options?: any, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.queryFleetsFleetsGet( - fleetName, - limit, - offset, - orderBy, - options, - ); + const localVarAxiosArgs = await localVarAxiosParamCreator.getFleetsFleetsGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, }; @@ -4517,24 +5062,12 @@ export const FleetsApiFactory = function ( }, /** * - * @summary Query Fleets - * @param {string} [fleetName] comma separated list of fleet names - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * @summary Get Fleets * @param {*} [options] Override http request option. * @throws {RequiredError} */ - queryFleetsFleetsGet( - fleetName?: string, - limit?: number, - offset?: number, - orderBy?: string, - options?: any, - ): AxiosPromise> { - return localVarFp - .queryFleetsFleetsGet(fleetName, limit, offset, orderBy, options) - .then((request) => request(axios, basePath)); + getFleetsFleetsGet(options?: any): AxiosPromise> { + return localVarFp.getFleetsFleetsGet(options).then((request) => request(axios, basePath)); }, }; }; @@ -4577,24 +5110,14 @@ export class FleetsApi extends BaseAPI { /** * - * @summary Query Fleets - * @param {string} [fleetName] comma separated list of fleet names - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * @summary Get Fleets * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FleetsApi */ - public queryFleetsFleetsGet( - fleetName?: string, - limit?: number, - offset?: number, - orderBy?: string, - options?: any, - ) { + public getFleetsFleetsGet(options?: any) { return FleetsApiFp(this.configuration) - .queryFleetsFleetsGet(fleetName, limit, offset, orderBy, options) + .getFleetsFleetsGet(options) .then((request) => request(this.axios, this.basePath)); } } @@ -5358,22 +5881,22 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration }, /** * - * @summary Post Cancel Task - * @param {CancelTaskRequest} cancelTaskRequest + * @summary Post Activity Discovery + * @param {ActivityDiscoveryRequest} activityDiscoveryRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postCancelTaskTasksCancelTaskPost: async ( - cancelTaskRequest: CancelTaskRequest, + postActivityDiscoveryTasksActivityDiscoveryPost: async ( + activityDiscoveryRequest: ActivityDiscoveryRequest, options: any = {}, ): Promise => { - // verify required parameter 'cancelTaskRequest' is not null or undefined + // verify required parameter 'activityDiscoveryRequest' is not null or undefined assertParamExists( - 'postCancelTaskTasksCancelTaskPost', - 'cancelTaskRequest', - cancelTaskRequest, + 'postActivityDiscoveryTasksActivityDiscoveryPost', + 'activityDiscoveryRequest', + activityDiscoveryRequest, ); - const localVarPath = `/tasks/cancel_task`; + const localVarPath = `/tasks/activity_discovery`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -5395,7 +5918,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration ...options.headers, }; localVarRequestOptions.data = serializeDataIfNeeded( - cancelTaskRequest, + activityDiscoveryRequest, localVarRequestOptions, configuration, ); @@ -5407,18 +5930,22 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration }, /** * - * @summary Post Task Request - * @param {TaskRequest} taskRequest + * @summary Post Cancel Task + * @param {CancelTaskRequest} cancelTaskRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postTaskRequestTasksTaskRequestPost: async ( - taskRequest: TaskRequest, + postCancelTaskTasksCancelTaskPost: async ( + cancelTaskRequest: CancelTaskRequest, options: any = {}, ): Promise => { - // verify required parameter 'taskRequest' is not null or undefined - assertParamExists('postTaskRequestTasksTaskRequestPost', 'taskRequest', taskRequest); - const localVarPath = `/tasks/task_request`; + // verify required parameter 'cancelTaskRequest' is not null or undefined + assertParamExists( + 'postCancelTaskTasksCancelTaskPost', + 'cancelTaskRequest', + cancelTaskRequest, + ); + const localVarPath = `/tasks/cancel_task`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -5440,7 +5967,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration ...options.headers, }; localVarRequestOptions.data = serializeDataIfNeeded( - taskRequest, + cancelTaskRequest, localVarRequestOptions, configuration, ); @@ -5452,28 +5979,22 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration }, /** * - * @summary Query Task States - * @param {string} [taskId] comma separated list of task ids - * @param {string} [category] comma separated list of task categories - * @param {string} [startTime] - * @param {string} [finishTime] - * @param {number} [limit] - * @param {number} [offset] - * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * @summary Post Interrupt Task + * @param {TaskInterruptionRequest} taskInterruptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - queryTaskStatesTasksGet: async ( - taskId?: string, - category?: string, - startTime?: string, - finishTime?: string, - limit?: number, - offset?: number, - orderBy?: string, + postInterruptTaskTasksInterruptTaskPost: async ( + taskInterruptionRequest: TaskInterruptionRequest, options: any = {}, ): Promise => { - const localVarPath = `/tasks`; + // verify required parameter 'taskInterruptionRequest' is not null or undefined + assertParamExists( + 'postInterruptTaskTasksInterruptTaskPost', + 'taskInterruptionRequest', + taskInterruptionRequest, + ); + const localVarPath = `/tasks/interrupt_task`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); let baseOptions; @@ -5481,24 +6002,418 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration baseOptions = configuration.baseOptions; } - const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options }; + const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options }; const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - if (taskId !== undefined) { - localVarQueryParameter['task_id'] = taskId; - } - - if (category !== undefined) { - localVarQueryParameter['category'] = category; - } - - if (startTime !== undefined) { - localVarQueryParameter['start_time'] = - (startTime as any) instanceof Date ? (startTime as any).toISOString() : startTime; - } + localVarHeaderParameter['Content-Type'] = 'application/json'; - if (finishTime !== undefined) { + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + taskInterruptionRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Post Kill Task + * @param {TaskKillRequest} taskKillRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postKillTaskTasksKillTaskPost: async ( + taskKillRequest: TaskKillRequest, + options: any = {}, + ): Promise => { + // verify required parameter 'taskKillRequest' is not null or undefined + assertParamExists('postKillTaskTasksKillTaskPost', 'taskKillRequest', taskKillRequest); + const localVarPath = `/tasks/kill_task`; + // 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; + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + taskKillRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Post Resume Task + * @param {TaskResumeRequest} taskResumeRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postResumeTaskTasksResumeTaskPost: async ( + taskResumeRequest: TaskResumeRequest, + options: any = {}, + ): Promise => { + // verify required parameter 'taskResumeRequest' is not null or undefined + assertParamExists( + 'postResumeTaskTasksResumeTaskPost', + 'taskResumeRequest', + taskResumeRequest, + ); + const localVarPath = `/tasks/resume_task`; + // 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; + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + taskResumeRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Post Rewind Task + * @param {TaskRewindRequest} taskRewindRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postRewindTaskTasksRewindTaskPost: async ( + taskRewindRequest: TaskRewindRequest, + options: any = {}, + ): Promise => { + // verify required parameter 'taskRewindRequest' is not null or undefined + assertParamExists( + 'postRewindTaskTasksRewindTaskPost', + 'taskRewindRequest', + taskRewindRequest, + ); + const localVarPath = `/tasks/rewind_task`; + // 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; + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + taskRewindRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Post Skip Phase + * @param {TaskPhaseSkipRequest} taskPhaseSkipRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postSkipPhaseTasksSkipPhasePost: async ( + taskPhaseSkipRequest: TaskPhaseSkipRequest, + options: any = {}, + ): Promise => { + // verify required parameter 'taskPhaseSkipRequest' is not null or undefined + assertParamExists( + 'postSkipPhaseTasksSkipPhasePost', + 'taskPhaseSkipRequest', + taskPhaseSkipRequest, + ); + const localVarPath = `/tasks/skip_phase`; + // 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; + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + taskPhaseSkipRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Post Task Discovery + * @param {TaskDiscoveryRequest} taskDiscoveryRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postTaskDiscoveryTasksTaskDiscoveryPost: async ( + taskDiscoveryRequest: TaskDiscoveryRequest, + options: any = {}, + ): Promise => { + // verify required parameter 'taskDiscoveryRequest' is not null or undefined + assertParamExists( + 'postTaskDiscoveryTasksTaskDiscoveryPost', + 'taskDiscoveryRequest', + taskDiscoveryRequest, + ); + const localVarPath = `/tasks/task_discovery`; + // 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; + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + taskDiscoveryRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Post Task Request + * @param {DispatchTaskRequest} dispatchTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postTaskRequestTasksDispatchTaskPost: async ( + dispatchTaskRequest: DispatchTaskRequest, + options: any = {}, + ): Promise => { + // verify required parameter 'dispatchTaskRequest' is not null or undefined + assertParamExists( + 'postTaskRequestTasksDispatchTaskPost', + 'dispatchTaskRequest', + dispatchTaskRequest, + ); + const localVarPath = `/tasks/dispatch_task`; + // 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; + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + dispatchTaskRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Post Undo Skip Phase + * @param {UndoPhaseSkipRequest} undoPhaseSkipRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postUndoSkipPhaseTasksUndoSkipPhasePost: async ( + undoPhaseSkipRequest: UndoPhaseSkipRequest, + options: any = {}, + ): Promise => { + // verify required parameter 'undoPhaseSkipRequest' is not null or undefined + assertParamExists( + 'postUndoSkipPhaseTasksUndoSkipPhasePost', + 'undoPhaseSkipRequest', + undoPhaseSkipRequest, + ); + const localVarPath = `/tasks/undo_skip_phase`; + // 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; + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + undoPhaseSkipRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, + /** + * + * @summary Query Task States + * @param {string} [taskId] comma separated list of task ids + * @param {string} [category] comma separated list of task categories + * @param {string} [startTime] + * @param {string} [finishTime] + * @param {number} [limit] + * @param {number} [offset] + * @param {string} [orderBy] common separated list of fields to order by, prefix with \'-\' to sort descendingly. + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + queryTaskStatesTasksGet: async ( + taskId?: string, + category?: string, + startTime?: string, + finishTime?: string, + limit?: number, + offset?: number, + orderBy?: string, + options: any = {}, + ): Promise => { + const localVarPath = `/tasks`; + // 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: 'GET', ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + if (taskId !== undefined) { + localVarQueryParameter['task_id'] = taskId; + } + + if (category !== undefined) { + localVarQueryParameter['category'] = category; + } + + if (startTime !== undefined) { + localVarQueryParameter['start_time'] = + (startTime as any) instanceof Date ? (startTime as any).toISOString() : startTime; + } + + if (finishTime !== undefined) { localVarQueryParameter['finish_time'] = (finishTime as any) instanceof Date ? (finishTime as any).toISOString() : finishTime; } @@ -5575,6 +6490,24 @@ export const TasksApiFp = function (configuration?: Configuration) { ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Post Activity Discovery + * @param {ActivityDiscoveryRequest} activityDiscoveryRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postActivityDiscoveryTasksActivityDiscoveryPost( + activityDiscoveryRequest: ActivityDiscoveryRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = + await localVarAxiosParamCreator.postActivityDiscoveryTasksActivityDiscoveryPost( + activityDiscoveryRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Post Cancel Task @@ -5594,21 +6527,146 @@ export const TasksApiFp = function (configuration?: Configuration) { }, /** * - * @summary Post Task Request - * @param {TaskRequest} taskRequest + * @summary Post Interrupt Task + * @param {TaskInterruptionRequest} taskInterruptionRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async postTaskRequestTasksTaskRequestPost( - taskRequest: TaskRequest, + async postInterruptTaskTasksInterruptTaskPost( + taskInterruptionRequest: TaskInterruptionRequest, options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postTaskRequestTasksTaskRequestPost( - taskRequest, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.postInterruptTaskTasksInterruptTaskPost( + taskInterruptionRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Post Kill Task + * @param {TaskKillRequest} taskKillRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postKillTaskTasksKillTaskPost( + taskKillRequest: TaskKillRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postKillTaskTasksKillTaskPost( + taskKillRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Post Resume Task + * @param {TaskResumeRequest} taskResumeRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postResumeTaskTasksResumeTaskPost( + taskResumeRequest: TaskResumeRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postResumeTaskTasksResumeTaskPost( + taskResumeRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Post Rewind Task + * @param {TaskRewindRequest} taskRewindRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postRewindTaskTasksRewindTaskPost( + taskRewindRequest: TaskRewindRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postRewindTaskTasksRewindTaskPost( + taskRewindRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Post Skip Phase + * @param {TaskPhaseSkipRequest} taskPhaseSkipRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postSkipPhaseTasksSkipPhasePost( + taskPhaseSkipRequest: TaskPhaseSkipRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postSkipPhaseTasksSkipPhasePost( + taskPhaseSkipRequest, options, ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Post Task Discovery + * @param {TaskDiscoveryRequest} taskDiscoveryRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postTaskDiscoveryTasksTaskDiscoveryPost( + taskDiscoveryRequest: TaskDiscoveryRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = + await localVarAxiosParamCreator.postTaskDiscoveryTasksTaskDiscoveryPost( + taskDiscoveryRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Post Task Request + * @param {DispatchTaskRequest} dispatchTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postTaskRequestTasksDispatchTaskPost( + dispatchTaskRequest: DispatchTaskRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = + await localVarAxiosParamCreator.postTaskRequestTasksDispatchTaskPost( + dispatchTaskRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, + /** + * + * @summary Post Undo Skip Phase + * @param {UndoPhaseSkipRequest} undoPhaseSkipRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postUndoSkipPhaseTasksUndoSkipPhasePost( + undoPhaseSkipRequest: UndoPhaseSkipRequest, + options?: any, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = + await localVarAxiosParamCreator.postUndoSkipPhaseTasksUndoSkipPhasePost( + undoPhaseSkipRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Query Task States @@ -5687,6 +6745,21 @@ export const TasksApiFactory = function ( .getTaskStateTasksTaskIdStateGet(taskId, options) .then((request) => request(axios, basePath)); }, + /** + * + * @summary Post Activity Discovery + * @param {ActivityDiscoveryRequest} activityDiscoveryRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postActivityDiscoveryTasksActivityDiscoveryPost( + activityDiscoveryRequest: ActivityDiscoveryRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .postActivityDiscoveryTasksActivityDiscoveryPost(activityDiscoveryRequest, options) + .then((request) => request(axios, basePath)); + }, /** * * @summary Post Cancel Task @@ -5702,19 +6775,124 @@ export const TasksApiFactory = function ( .postCancelTaskTasksCancelTaskPost(cancelTaskRequest, options) .then((request) => request(axios, basePath)); }, + /** + * + * @summary Post Interrupt Task + * @param {TaskInterruptionRequest} taskInterruptionRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postInterruptTaskTasksInterruptTaskPost( + taskInterruptionRequest: TaskInterruptionRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .postInterruptTaskTasksInterruptTaskPost(taskInterruptionRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * + * @summary Post Kill Task + * @param {TaskKillRequest} taskKillRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postKillTaskTasksKillTaskPost( + taskKillRequest: TaskKillRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .postKillTaskTasksKillTaskPost(taskKillRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * + * @summary Post Resume Task + * @param {TaskResumeRequest} taskResumeRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postResumeTaskTasksResumeTaskPost( + taskResumeRequest: TaskResumeRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .postResumeTaskTasksResumeTaskPost(taskResumeRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * + * @summary Post Rewind Task + * @param {TaskRewindRequest} taskRewindRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postRewindTaskTasksRewindTaskPost( + taskRewindRequest: TaskRewindRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .postRewindTaskTasksRewindTaskPost(taskRewindRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * + * @summary Post Skip Phase + * @param {TaskPhaseSkipRequest} taskPhaseSkipRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postSkipPhaseTasksSkipPhasePost( + taskPhaseSkipRequest: TaskPhaseSkipRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .postSkipPhaseTasksSkipPhasePost(taskPhaseSkipRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * + * @summary Post Task Discovery + * @param {TaskDiscoveryRequest} taskDiscoveryRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postTaskDiscoveryTasksTaskDiscoveryPost( + taskDiscoveryRequest: TaskDiscoveryRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .postTaskDiscoveryTasksTaskDiscoveryPost(taskDiscoveryRequest, options) + .then((request) => request(axios, basePath)); + }, /** * * @summary Post Task Request - * @param {TaskRequest} taskRequest + * @param {DispatchTaskRequest} dispatchTaskRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postTaskRequestTasksTaskRequestPost( - taskRequest: TaskRequest, + postTaskRequestTasksDispatchTaskPost( + dispatchTaskRequest: DispatchTaskRequest, options?: any, - ): AxiosPromise { + ): AxiosPromise { + return localVarFp + .postTaskRequestTasksDispatchTaskPost(dispatchTaskRequest, options) + .then((request) => request(axios, basePath)); + }, + /** + * + * @summary Post Undo Skip Phase + * @param {UndoPhaseSkipRequest} undoPhaseSkipRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postUndoSkipPhaseTasksUndoSkipPhasePost( + undoPhaseSkipRequest: UndoPhaseSkipRequest, + options?: any, + ): AxiosPromise { return localVarFp - .postTaskRequestTasksTaskRequestPost(taskRequest, options) + .postUndoSkipPhaseTasksUndoSkipPhasePost(undoPhaseSkipRequest, options) .then((request) => request(axios, basePath)); }, /** @@ -5792,6 +6970,23 @@ export class TasksApi extends BaseAPI { .then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Post Activity Discovery + * @param {ActivityDiscoveryRequest} activityDiscoveryRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postActivityDiscoveryTasksActivityDiscoveryPost( + activityDiscoveryRequest: ActivityDiscoveryRequest, + options?: any, + ) { + return TasksApiFp(this.configuration) + .postActivityDiscoveryTasksActivityDiscoveryPost(activityDiscoveryRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Post Cancel Task @@ -5806,17 +7001,130 @@ export class TasksApi extends BaseAPI { .then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Post Interrupt Task + * @param {TaskInterruptionRequest} taskInterruptionRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postInterruptTaskTasksInterruptTaskPost( + taskInterruptionRequest: TaskInterruptionRequest, + options?: any, + ) { + return TasksApiFp(this.configuration) + .postInterruptTaskTasksInterruptTaskPost(taskInterruptionRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Post Kill Task + * @param {TaskKillRequest} taskKillRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postKillTaskTasksKillTaskPost(taskKillRequest: TaskKillRequest, options?: any) { + return TasksApiFp(this.configuration) + .postKillTaskTasksKillTaskPost(taskKillRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Post Resume Task + * @param {TaskResumeRequest} taskResumeRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postResumeTaskTasksResumeTaskPost(taskResumeRequest: TaskResumeRequest, options?: any) { + return TasksApiFp(this.configuration) + .postResumeTaskTasksResumeTaskPost(taskResumeRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Post Rewind Task + * @param {TaskRewindRequest} taskRewindRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postRewindTaskTasksRewindTaskPost(taskRewindRequest: TaskRewindRequest, options?: any) { + return TasksApiFp(this.configuration) + .postRewindTaskTasksRewindTaskPost(taskRewindRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Post Skip Phase + * @param {TaskPhaseSkipRequest} taskPhaseSkipRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postSkipPhaseTasksSkipPhasePost( + taskPhaseSkipRequest: TaskPhaseSkipRequest, + options?: any, + ) { + return TasksApiFp(this.configuration) + .postSkipPhaseTasksSkipPhasePost(taskPhaseSkipRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Post Task Discovery + * @param {TaskDiscoveryRequest} taskDiscoveryRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postTaskDiscoveryTasksTaskDiscoveryPost( + taskDiscoveryRequest: TaskDiscoveryRequest, + options?: any, + ) { + return TasksApiFp(this.configuration) + .postTaskDiscoveryTasksTaskDiscoveryPost(taskDiscoveryRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Post Task Request - * @param {TaskRequest} taskRequest + * @param {DispatchTaskRequest} dispatchTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postTaskRequestTasksDispatchTaskPost( + dispatchTaskRequest: DispatchTaskRequest, + options?: any, + ) { + return TasksApiFp(this.configuration) + .postTaskRequestTasksDispatchTaskPost(dispatchTaskRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + + /** + * + * @summary Post Undo Skip Phase + * @param {UndoPhaseSkipRequest} undoPhaseSkipRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof TasksApi */ - public postTaskRequestTasksTaskRequestPost(taskRequest: TaskRequest, options?: any) { + public postUndoSkipPhaseTasksUndoSkipPhasePost( + undoPhaseSkipRequest: UndoPhaseSkipRequest, + options?: any, + ) { return TasksApiFp(this.configuration) - .postTaskRequestTasksTaskRequestPost(taskRequest, options) + .postUndoSkipPhaseTasksUndoSkipPhasePost(undoPhaseSkipRequest, options) .then((request) => request(this.axios, this.basePath)); } diff --git a/packages/api-client/lib/version.ts b/packages/api-client/lib/version.ts index b3a66384f..619db289c 100644 --- a/packages/api-client/lib/version.ts +++ b/packages/api-client/lib/version.ts @@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models'; export const version = { rmfModels: rmfModelVer, - rmfServer: '9e6287bacb8cd75693910a49ab012b593703c005', + rmfServer: '4e3f02ef452d1360da2f861a9ce947069694aaec', openapiGenerator: '5.2.1', }; From 38e57d28419d67273d627a31e5e8c26c42ab9ba1 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 24 Jan 2022 02:20:06 +0000 Subject: [PATCH 37/79] remove todo Signed-off-by: Teo Koon Peng --- Pipfile | 4 ---- 1 file changed, 4 deletions(-) diff --git a/Pipfile b/Pipfile index 9648c2f9c..774c35762 100644 --- a/Pipfile +++ b/Pipfile @@ -14,10 +14,6 @@ coverage = "~=5.5" api-server = {editable = true, path = "./packages/api-server"} requests = "~=2.25" asyncpg = "~=0.24.0" -# TODO: install datamodel-code-generator in it's own venv. -# Because this breaks dependencies because pipenv cannot find a suitable version of black -# even though it is available (it's is known "feature" of pipenv). -# datamodel-code-generator = "~=0.11.15" websocket-client = "~=1.2.3" # reporting-server reporting-server = {editable = true, path = "./packages/reporting-server"} From d6f5e226fa127672fd1dcca8945b9dce0add3822 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 27 Jan 2022 02:22:37 +0000 Subject: [PATCH 38/79] port create task form Signed-off-by: Teo Koon Peng --- .../api_server/routes/tasks/tasks.py | 6 + .../src/components/rmf-app/rmf-app.tsx | 2 +- .../src/components/robots/robot-page.tsx | 7 +- .../src/components/tasks/task-page.tsx | 13 +- .../src/components/tasks/task-panel.tsx | 23 +- .../src/util/common-subscriptions.ts | 2 +- .../lib/tasks/create-task.stories.tsx | 8 +- .../lib/tasks/create-task.tsx | 243 ++++++++++-------- .../lib/tasks/test-data.spec.ts | 11 +- 9 files changed, 182 insertions(+), 133 deletions(-) diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index 8e8d1ea34..730caa96d 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -1,3 +1,4 @@ +import json from datetime import datetime from typing import List, Optional, Tuple, cast @@ -110,7 +111,12 @@ async def post_cancel_task( @router.post("/dispatch_task", response_model=mdl.TaskDispatchResponse) async def post_task_request( request: mdl.DispatchTaskRequest = Body(...), + task_repo: TaskRepository = Depends(task_repo_dep), ): + result = mdl.TaskState.parse_raw( + await tasks_service.call(request.json(exclude_none=True)) + ) + await task_repo.save_task_state(result) return RawJSONResponse(await tasks_service.call(request.json(exclude_none=True))) diff --git a/packages/dashboard/src/components/rmf-app/rmf-app.tsx b/packages/dashboard/src/components/rmf-app/rmf-app.tsx index 9f66ae77a..813420f6d 100644 --- a/packages/dashboard/src/components/rmf-app/rmf-app.tsx +++ b/packages/dashboard/src/components/rmf-app/rmf-app.tsx @@ -106,7 +106,7 @@ function FleetsProvider(props: React.PropsWithChildren<{}>): JSX.Element { } let cancel = false; (async () => { - const results = await fleetsApi.queryFleetsFleetsGet(); + const results = await fleetsApi.getFleetsFleetsGet(); if (cancel || results.status !== 200) return; setFleets(results.data); })(); diff --git a/packages/dashboard/src/components/robots/robot-page.tsx b/packages/dashboard/src/components/robots/robot-page.tsx index 19f43d196..e3c559ae9 100644 --- a/packages/dashboard/src/components/robots/robot-page.tsx +++ b/packages/dashboard/src/components/robots/robot-page.tsx @@ -75,12 +75,7 @@ export function RobotPage() { setHasMore(false); return []; } - const resp = await rmfIngress.fleetsApi.queryFleetsFleetsGet( - undefined, - undefined, - undefined, - undefined, - ); + const resp = await rmfIngress.fleetsApi.getFleetsFleetsGet(); let robotState: RobotState[] = []; resp.data?.forEach((fleet) => { const robotKey = fleet.robots && Object.keys(fleet.robots); diff --git a/packages/dashboard/src/components/tasks/task-page.tsx b/packages/dashboard/src/components/tasks/task-page.tsx index ada475879..c6e11ab21 100644 --- a/packages/dashboard/src/components/tasks/task-page.tsx +++ b/packages/dashboard/src/components/tasks/task-page.tsx @@ -43,7 +43,7 @@ export function TaskPage() { undefined, 11, page * 10, - '-start_time', + '-unix_millis_start_time', undefined, ); const results = resp.data as TaskState[]; @@ -77,11 +77,18 @@ export function TaskPage() { }, [handleRefresh]); const submitTasks = React.useCallback['submitTasks']>( - async (tasks) => { + async (taskRequests) => { if (!tasksApi) { throw new Error('tasks api not available'); } - await Promise.all(tasks.map((t) => tasksApi.postTaskRequestTasksTaskRequestPost(t))); + await Promise.all( + taskRequests.map((taskReq) => + tasksApi.postTaskRequestTasksDispatchTaskPost({ + type: 'dispatch_task_request', + request: taskReq, + }), + ), + ); handleRefresh(); }, [tasksApi, handleRefresh], diff --git a/packages/dashboard/src/components/tasks/task-panel.tsx b/packages/dashboard/src/components/tasks/task-panel.tsx index c7ca74ead..2377276bb 100644 --- a/packages/dashboard/src/components/tasks/task-panel.tsx +++ b/packages/dashboard/src/components/tasks/task-panel.tsx @@ -1,3 +1,8 @@ +import { + AddOutlined as AddOutlinedIcon, + Autorenew as AutorenewIcon, + Refresh as RefreshIcon, +} from '@mui/icons-material'; import { Alert, AlertProps, @@ -6,28 +11,23 @@ import { IconButton, Paper, Snackbar, + styled, TableContainer, TablePagination, Toolbar, Tooltip, Typography, useTheme, - styled, } from '@mui/material'; -import { - AddOutlined as AddOutlinedIcon, - Autorenew as AutorenewIcon, - Refresh as RefreshIcon, -} from '@mui/icons-material'; -import { TaskState, TaskEventLog } from 'api-client'; +import { TaskEventLog, TaskState } from 'api-client'; import React from 'react'; import { CreateTaskForm, CreateTaskFormProps, TaskInfo, TaskTable } from 'react-components'; import { UserProfileContext } from 'rmf-auth'; import { AppControllerContext } from '../app-contexts'; import { Enforcer } from '../permissions'; -import { parseTasksFile } from './utils'; -import { TaskLogs } from './task-logs'; import { RmfIngressContext } from '../rmf-app'; +import { TaskLogs } from './task-logs'; +import { parseTasksFile } from './utils'; const prefix = 'task-panel'; const classes = { @@ -106,7 +106,6 @@ export function TaskPanel({ const [snackbarMessage, setSnackbarMessage] = React.useState(''); const [snackbarSeverity, setSnackbarSeverity] = React.useState('success'); const [autoRefresh, setAutoRefresh] = React.useState(true); - const [showLogs, setShowLogs] = React.useState(false); const [selectedTaskLog, setSelectedTaskLog] = React.useState(undefined); const profile = React.useContext(UserProfileContext); const { showErrorAlert } = React.useContext(AppControllerContext); @@ -229,7 +228,7 @@ export function TaskPanel({ {selectedTask ? ( <> - + - - ) : ( - - )} - - {selectedTaskLog ? : null} + + + + + Tasks + + + { + setAutoRefresh((prev) => !prev); + onAutoRefresh && onAutoRefresh(!autoRefresh); + }} + aria-label={`${autoRefreshTooltipPrefix} auto refresh`} + > + + + + + onRefresh && onRefresh()} aria-label="Refresh"> + + + + + setOpenCreateTaskForm(true)} aria-label="Create Task"> + + + + + + t)} + onTaskClick={(_ev, task) => + setSelectedTask(tasks.find((t) => t.booking.id === task.booking.id)) + } + /> + + {paginationOptions && ( + + )} + + + + + {selectedTask ? ( + <> + {selectedTaskState && taskCancellable ? ( + + ) : null} + + ) : ( + + )} + + + + + {selectedTaskLog && selectedTaskState && taskCancellable ? ( + + ) : null} + {openCreateTaskForm && ( setOpenCreateTaskForm(false)} submitTasks={submitTasks} - tasksFromFile={tasksFromFile} + // tasksFromFile={tasksFromFile} onSuccess={() => { setOpenCreateTaskForm(false); setSnackbarSeverity('success'); diff --git a/packages/dashboard/src/components/tasks/tests/make-tasks.ts b/packages/dashboard/src/components/tasks/tests/make-tasks.ts index 654c0609b..edb455585 100644 --- a/packages/dashboard/src/components/tasks/tests/make-tasks.ts +++ b/packages/dashboard/src/components/tasks/tests/make-tasks.ts @@ -9,6 +9,18 @@ // TaskSummary, // } from 'api-client'; // import { TaskSummary as RmfTaskSummary } from 'rmf-models'; +import { + TaskEventLog, + TaskState, + Phases, + LogEntry, + Tier, + Booking, + Detail, + Status, + Phase, + EventState, +} from 'api-client'; import react from 'react'; /** * FIXME: These `makeX` functions are duplicated in `react-components`. @@ -153,3 +165,627 @@ import react from 'react'; // summary: taskSummary, // }; // } + +// export function makeLogEntry(): LogEntry { +// return { +// seq: 0, +// tier: Tier.Info, +// unix_millis_time: 90000, +// text: 'Open Door', +// }; +// } + +// export function makePhases(logEntries: Array): Phases { +// return { +// log: logEntries, +// events: { '0': logEntries }, +// }; +// } + +// export function makeEventState(eventId: number, deps?: Array): EventState { +// return { +// id: eventId, +// status: Status.Underway, +// name: '-', +// detail: '', +// deps: deps, +// }; +// } + +// export function makePhase(phaseId: number): Phase { +// const eventState0 = makeEventState(0); +// const eventState1 = makeEventState(1, [0]); +// return { +// id: phaseId, +// category: '', +// detail: '', +// unix_millis_start_time: 90000, +// unix_millis_finish_time: 90009, +// original_estimate_millis: 900000, +// estimate_millis: 1000, +// events: { '0': eventState0, '1': eventState1 }, +// }; +// } + +// export function makeTaskEventLog(taskId: string): TaskEventLog { +// const logEntry = makeLogEntry(); +// const phases = makePhases([logEntry]); +// return { +// task_id: taskId, +// log: [logEntry], +// phases: { '0': phases }, +// }; +// } + +// export function makeBooking(bookingId: string): Booking { +// return { +// id: bookingId, +// unix_millis_earliest_start_time: 90000, +// priority: '1', +// labels: ['', ''], +// }; +// } + +// export function makeTaskEventState(taskId: string): TaskState { +// const booking = makeBooking(taskId); +// const phase = makePhase(0); +// return { +// booking: booking, +// category: '', +// detail: '', +// unix_millis_start_time: 90000, +// unix_millis_finish_time: 90009, +// original_estimate_millis: 90009, +// estimate_millis: 1000, +// status: Status.Underway, +// completed: [], +// phases: { '0': phase }, +// }; +// } + +export function makeTaskState(taskId: string): TaskState { + const state = JSON.parse(`{ + "booking": { + "id": "delivery_2021:11:08:23:50", + "unix_millis_earliest_start_time": 1636388400000, + "priority": "none", + "automatic": false + }, + "category": "Multi-Delivery", + "detail": [ + { + "category": "Pick Up", + "params": { + "location": "Kitchen", + "items": [ + { + "type": "soda", + "quantity": 1 + }, + { + "type": "water", + "quantity": 1 + } + ] + } + }, + { + "category": "Drop Off", + "params": { + "location": "room_203", + "items": [ + { + "type": "soda", + "quantity": 1 + } + ] + } + }, + { + "category": "Drop Off", + "params": { + "location": "room_521", + "items": [ + { + "type": "water", + "quantity": 1 + } + ] + } + } + ], + "unix_millis_start_time": 1636388410000, + "estimate_millis": 2000000, + "phases": { + "1": { + "id": 1, + "category": "Pick Up", + "detail": { + "location": "Kitchen", + "items": [ + { + "type": "soda", + "quantity": 1 + }, + { + "type": "water", + "quantity": 1 + } + ] + }, + "estimate_millis": 600000, + "final_event_id": 0, + "events": { + "0": { + "id": 0, + "status": "completed", + "name": "Pick Up Sequence", + "detail": "", + "deps": [1, 2] + }, + "1": { + "id": 1, + "status": "completed", + "name": "Go to [place:kitchen]", + "detail": "", + "deps": [3, 4, 8] + }, + "2": { + "id": 2, + "status": "completed", + "name": "Receive items", + "detail": [ + { + "type": "soda", + "quantity": 1 + }, + { + "type": "water", + "quantity": 1 + } + ], + "deps": [] + }, + "3": { + "id": 3, + "status": "completed", + "name": "Move to [place:kitchen_door_exterior]", + "detail": "", + "deps": [] + }, + "4": { + "id": 4, + "status": "completed", + "name": "Pass through [door:kitchen_door]", + "detail": "", + "deps": [5, 6, 7] + }, + "5": { + "id": 5, + "status": "completed", + "name": "Wait for [door:kitchen_door] to open", + "detail": "", + "deps": [] + }, + "6": { + "id": 6, + "status": "completed", + "name": "Move to [place:kitchen_door_interior]", + "detail": "", + "deps": [] + }, + "7": { + "id": 7, + "status": "completed", + "name": "Wait for [door:kitchen_door] to close", + "detail": "", + "deps": [] + }, + "8": { + "id": 8, + "status": "completed", + "name": "Move to [place:kitchen]", + "detail": "", + "deps": [] + } + } + }, + "2": { + "id": 2, + "category": "Drop Off", + "detail": { + "location": "room_203", + "items": [ + { + "type": "soda", + "quantity": 1 + } + ] + }, + "estimate_millis": 720000, + "final_event_id": 0, + "events": { + "0": { + "id": 0, + "status": "underway", + "name": "Drop Off Sequence", + "detail": "", + "deps": [1, 2] + }, + "1": { + "id": 1, + "status": "underway", + "name": "Go to [place:room_203]", + "detail": "", + "deps": [3, 4, 8, 9, 14] + }, + "2": { + "id": 2, + "status": "standby", + "name": "Unload items", + "detail": [ + { + "type": "soda", + "quantity": 1 + } + ], + "deps": [] + }, + "3": { + "id": 3, + "status": "completed", + "name": "Move to [place:kitchen_door_interior]", + "detail": "", + "deps": [] + }, + "4": { + "id": 4, + "status": "underway", + "name": "Pass through [door:kitchen_door]", + "detail": "", + "deps": [5, 6, 7] + }, + "5": { + "id": 5, + "status": "underway", + "name": "Wait for [door:kitchen_door] to open", + "detail": "", + "deps": [] + }, + "6": { + "id": 6, + "status": "standby", + "name": "Move to [place:kitchen_door_exterior]", + "detail": "", + "deps": [] + }, + "7": { + "id": 7, + "status": "standby", + "name": "Wait for [door:kitchen_door] to close", + "detail": "", + "deps": [] + }, + "8": { + "id": 8, + "status": "standby", + "name": "Move to [place:lift_lobby_05_floor_B1]", + "detail": "", + "deps": [] + }, + "9": { + "id": 9, + "status": "standby", + "name": "Take [lift:lift_05_03] to [place:lift_lobby_05_floor_L2]", + "detail": "", + "deps": [10, 11, 12, 13] + }, + "10": { + "id": 10, + "status": "underway", + "name": "Wait for lift", + "detail": "Currently assigned [lift:lift_05_03]", + "deps": [] + }, + "11": { + "id": 11, + "status": "standby", + "name": "Move to [place:lift_05_03_floor_B1]", + "detail": "", + "deps": [] + }, + "12": { + "id": 12, + "status": "standby", + "name": "Lift [lift:lift_05_03] to [place:lift_05_03_floor_2]", + "detail": "", + "deps": [] + }, + "13": { + "id": 13, + "status": "standby", + "name": "Wait for [lift:lift_05_03] to open", + "detail": "", + "deps": [] + }, + "14": { + "id": 14, + "status": "standby", + "name": "Move to [place:room_203]", + "detail": "", + "deps": [] + } + } + }, + "3": { + "id": 3, + "category": "Drop Off", + "detail": { + "location": "room_521", + "items": [ + { + "type": "water", + "quantity": 1 + } + ] + }, + "estimate_millis": 680000 + } + }, + "completed": [ 1 ], + "active": 2, + "pending": [ 3 ] + } + `); + state.booking.id = taskId; + return state; +} + +export function makeTaskLog(taskId: string): TaskEventLog { + const log = JSON.parse(`{ + "task_id": "delivery_2021:11:08:23:50", + "log": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388410000, + "text": "Beginning task" + } + ], + "phases": { + "1": { + "log": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388410000, + "text": "Beginning phase" + } + ], + "events": { + "1": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388409995, + "text": "Generating plan to get from [place:parking_03] to [place:kitchen]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388409996, + "text": "Finished generating plan to get from [place:parking_03] to [place:kitchen]" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388414500, + "text": "Finished: Move to [place:kitchen_door_exterior]" + }, + { + "seq": 3, + "tier": "info", + "unix_millis_time": 1636388415000, + "text": "Finished: Wait for [door:kitchen_door] to open" + }, + { + "seq": 4, + "tier": "info", + "unix_millis_time": 1636388418001, + "text": "Finished: Move to [place:kitchen_door_interior]" + }, + { + "seq": 5, + "tier": "info", + "unix_millis_time": 1636388419111, + "text": "Finished: Wait for [door:kitchen_door] to close" + }, + { + "seq": 6, + "tier": "info", + "unix_millis_time": 1636388421121, + "text": "Finished: Move to [place:kitchen]" + } + ], + "2": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388421421, + "text": "Requested [item:soda], [item:water]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388421521, + "text": "Request acknowledged" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388430000, + "text": "Received [item:soda]" + }, + { + "seq": 3, + "tier": "info", + "unix_millis_time": 1636388440000, + "text": "Received [item:water]" + } + ], + "3": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388410000, + "text": "Moving towards [place:kitchen_door_exterior] from [place:parking_03]" + }, + { + "seq": 1, + "tier": "warning", + "unix_millis_time": 1636388411000, + "text": "Delayed by obstacle blocking [robot:deliverbot_01]" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388414500, + "text": "Arrived at [place:kitchen_door_exterior]" + } + ], + "5": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388414500, + "text": "Requested [door:kitchen_door] to open" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388414600, + "text": "[door:kitchen_door] acknowledged request" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388415000, + "text": "[door:kitchen_door] has opened" + } + ], + "6": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388415010, + "text": "Moving towards [place:kitchen_door_interior] from [place:kitchen_door_exterior]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388418000, + "text": "Arrived at [place:kitchen_door_interior]" + } + ], + "7": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388418010, + "text": "Requested [door:kitchen_door] to close" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388418110, + "text": "[door:kitchen_door] acknowledged request" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388419110, + "text": "[door:kitchen] has closed" + } + ], + "8": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388419120, + "text": "Moving towards [place:kitchen] from [place:kitchen_door_interior]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388421120, + "text": "Arrived at [place:kitchen]" + } + ] + } + }, + "2": { + "log": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388444500, + "text": "Beginning phase" + } + ], + "events": { + "1": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388440000, + "text": "Generating plan to get from [place:kitchen] to [place:room_203]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388440010, + "text": "Finished generating plan to get from [place:kitchen_03] to [place:room_203]" + }, + { + "seq": 2, + "tier": "info", + "unix_millis_time": 1636388450000, + "text": "Finished: Move to [place:kitchen_door_interior]" + } + ], + "3": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388440010, + "text": "Moving towards [place:kitchen_door_interior] from [place:kitchen]" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388450000, + "text": "Arrived at [place:kitchen_door_interior]" + } + ], + "5": [ + { + "seq": 0, + "tier": "info", + "unix_millis_time": 1636388450010, + "text": "Requested [door:kitchen_door] to open" + }, + { + "seq": 1, + "tier": "info", + "unix_millis_time": 1636388450110, + "text": "[door:kitchen_door] acknowledged request" + } + ] + } + } + } + } + `); + log.task_id = taskId; + return log; +} diff --git a/packages/dashboard/src/components/tasks/tests/task-logs.test.tsx b/packages/dashboard/src/components/tasks/tests/task-logs.test.tsx new file mode 100644 index 000000000..5200a5292 --- /dev/null +++ b/packages/dashboard/src/components/tasks/tests/task-logs.test.tsx @@ -0,0 +1,19 @@ +import React from 'react'; +import { render } from '../../tests/test-utils'; +import { TaskLogs } from '../task-logs'; +import { makeTaskLog, makeTaskState } from './make-tasks'; + +// react-leaflet doesn't work well in jsdom. +jest.mock('./../../schedule-visualizer', () => () => null); + +it('renders without crashing', async () => { + URL.createObjectURL = jest.fn(); + const taskLog = makeTaskLog('0'); + const taskState = makeTaskState('0'); + + const root = render(); + root.unmount(); + (URL.createObjectURL as jest.Mock).mockReset(); +}); + +export {}; diff --git a/packages/dashboard/src/components/tasks/tests/task-panel.test.tsx b/packages/dashboard/src/components/tasks/tests/task-panel.test.tsx index 8f65ed066..8ad4695b1 100644 --- a/packages/dashboard/src/components/tasks/tests/task-panel.test.tsx +++ b/packages/dashboard/src/components/tasks/tests/task-panel.test.tsx @@ -2,9 +2,23 @@ // import userEvent from '@testing-library/user-event'; import React from 'react'; // import { TaskSummary as RmfTaskSummary, TaskType as RmfTaskType } from 'rmf-models'; -// import { render } from '../../tests/test-utils'; -// import { TaskPanel, TaskPanelProps } from '../task-panel'; -// import { makeTaskWithPhases } from './make-tasks'; +import { render } from '../../tests/test-utils'; +import { TaskPanel, TaskPanelProps } from '../task-panel'; +import { makeTaskState } from './make-tasks'; + +// react-leaflet doesn't work well in jsdom. +jest.mock('./../../schedule-visualizer', () => () => null); + +it('renders without crashing', async () => { + URL.createObjectURL = jest.fn(); + const taskState = makeTaskState('0'); + + const root = render(); + root.unmount(); + (URL.createObjectURL as jest.Mock).mockReset(); +}); + +export {}; // describe('TaskPanel', () => { // describe('task detail', () => { diff --git a/packages/react-components/lib/tasks/task-info.tsx b/packages/react-components/lib/tasks/task-info.tsx index 26a23b77b..427c07b58 100644 --- a/packages/react-components/lib/tasks/task-info.tsx +++ b/packages/react-components/lib/tasks/task-info.tsx @@ -1,4 +1,4 @@ -import { Button, Divider, Typography, useTheme } from '@mui/material'; +import { Divider, Typography, useTheme } from '@mui/material'; import { styled } from '@mui/material'; import type { TaskState } from 'api-client'; import React from 'react'; diff --git a/packages/react-components/lib/tasks/task-logs.tsx b/packages/react-components/lib/tasks/task-logs.tsx index 8cd2010c9..4abcada13 100644 --- a/packages/react-components/lib/tasks/task-logs.tsx +++ b/packages/react-components/lib/tasks/task-logs.tsx @@ -1,30 +1,69 @@ -import { Divider, Grid, Paper, PaperProps, styled, Typography, useTheme } from '@mui/material'; -import { TaskEventLog } from 'api-client'; import React from 'react'; - +import { Divider, Grid, Paper, PaperProps, styled, Typography, useTheme } from '@mui/material'; +import { TaskEventLog, TaskState, EventState, Status, LogEntry } from 'api-client'; +import { format } from 'date-fns'; const prefix = 'task-logs'; const classes = { root: `${prefix}-root`, }; -export interface TaskLogsProps { +export interface TaskLogProps { taskLog: TaskEventLog; + taskState: TaskState; + fetchTaskLogs?: () => Promise; } const StyledPaper = styled((props: PaperProps) => )( ({ theme }) => ({ [`&.${classes.root}`]: { - padding: theme.spacing(2), - marginLeft: theme.spacing(2), + padding: theme.spacing(1), + width: '95%', flex: '0 0 auto', + maxHeight: '95%', + overflow: 'auto', }, }), ); -export function TaskLogs(props: TaskLogsProps) { - const { taskLog } = props; +export function TaskLogs({ taskLog, taskState }: TaskLogProps) { const theme = useTheme(); const phaseIds = taskLog.phases ? Object.keys(taskLog.phases) : []; + + function mapEventColor(event: EventState | null) { + // TODO(MXG): We should make this color selection consistent with the color + // selection that's done for task states. + if (event == null || event.status == null) return theme.palette.warning.light; + + switch (event.status) { + case Status.Uninitialized: + case Status.Blocked: + case Status.Error: + case Status.Failed: + return theme.palette.error.dark; + + case Status.Queued: + case Status.Standby: + return theme.palette.info.light; + + case Status.Underway: + return theme.palette.success.light; + + case Status.Delayed: + return theme.palette.warning.main; + + case Status.Skipped: + case Status.Canceled: + case Status.Killed: + return theme.palette.error.light; + + case Status.Completed: + return theme.palette.info.light; + + default: + return theme.palette.error.dark; + } + } + return ( @@ -36,25 +75,34 @@ export function TaskLogs(props: TaskLogsProps) { const getEventObj: any = taskLog.phases ? taskLog.phases[id] : null; const events = getEventObj ? getEventObj['events'] : {}; const eventIds = events ? Object.keys(events) : []; + const phaseStateObj = taskState.phases ? taskState.phases[id] : null; + const eventStates = phaseStateObj ? phaseStateObj.events : {}; + return ( - - {`Phase - ${id}`} + + {phaseStateObj && phaseStateObj.id ? phaseStateObj.id.toString() : 'unknown #'}.{' '} + {phaseStateObj && phaseStateObj.category ? phaseStateObj.category : 'undefined'} + {eventIds.length > 0 ? ( eventIds.map((idx) => { const event = events[idx]; + const eventState = eventStates ? eventStates[idx] : null; return (
- {`Event - ${idx}`} + + {eventState?.name} + {event.map((e: any, i: any) => { return ( - {new Date(e.unix_millis_time).toLocaleString()} + {format(new Date(e.unix_millis_time), "hh:mm:ss aaaaa'm'")} - + {e.text} @@ -98,7 +157,7 @@ export function TaskLogs(props: TaskLogsProps) { ) : (
- No Logs + No Logs to be shown
)} diff --git a/packages/react-components/lib/tasks/task-table.tsx b/packages/react-components/lib/tasks/task-table.tsx index af9998208..97889dfee 100644 --- a/packages/react-components/lib/tasks/task-table.tsx +++ b/packages/react-components/lib/tasks/task-table.tsx @@ -46,23 +46,24 @@ const StyledTable = styled((props: TableProps) =>
)(({ theme marginTop: theme.spacing(1), }, [`& .${classes.taskActiveCell}`]: { - backgroundColor: theme.palette.info.light, - color: theme.palette.getContrastText(theme.palette.info.light), + backgroundColor: theme.palette.success.light, + color: theme.palette.getContrastText(theme.palette.success.light), }, [`& .${classes.taskCancelledCell}`]: { backgroundColor: theme.palette.grey[500], + color: theme.palette.getContrastText(theme.palette.grey[500]), }, [`& .${classes.taskCompletedCell}`]: { - backgroundColor: theme.palette.success.main, - color: theme.palette.getContrastText(theme.palette.success.main), + backgroundColor: theme.palette.info.light, + color: theme.palette.getContrastText(theme.palette.info.light), }, [`& .${classes.taskFailedCell}`]: { backgroundColor: theme.palette.error.main, color: theme.palette.getContrastText(theme.palette.error.main), }, [`& .${classes.taskQueuedCell}`]: { - backgroundColor: theme.palette.info.dark, - color: theme.palette.getContrastText(theme.palette.info.light), + backgroundColor: theme.palette.grey[300], + color: theme.palette.getContrastText(theme.palette.grey[300]), }, [`& .${classes.taskUnknownCell}`]: { backgroundColor: theme.palette.warning.main, diff --git a/packages/react-components/lib/tasks/task-timeline.tsx b/packages/react-components/lib/tasks/task-timeline.tsx index 2dfef041e..006d8860b 100644 --- a/packages/react-components/lib/tasks/task-timeline.tsx +++ b/packages/react-components/lib/tasks/task-timeline.tsx @@ -5,6 +5,7 @@ import { TimelineConnector, TimelineContent, TimelineDot, + TimelineDotProps, TimelineItem, TimelineOppositeContent, TimelineProps, @@ -14,7 +15,8 @@ import { } from '@mui/lab'; import { styled } from '@mui/material'; import Typography from '@mui/material/Typography'; -import { TaskState } from 'api-client'; +import { format } from 'date-fns'; +import { TaskState, Phase, EventState, Status } from 'api-client'; import React from 'react'; interface TimeLinePropsWithRef extends TimelineProps { @@ -24,20 +26,18 @@ interface TimeLinePropsWithRef extends TimelineProps { const classes = { paper: 'timeline-paper', secondaryTail: 'timeline-secondary-tail', - pendingPhase: 'timeline-pending-phase', - completedPhase: 'timeline-completed-phase', - failedPhase: 'timeline-failed-phase', timelineRoot: 'timeline-root', }; + const StyledTimeLine = styled((props: TimeLinePropsWithRef) => )( ({ theme }) => ({ [`& .${classes.paper}`]: { padding: theme.spacing(1), marginTop: theme.spacing(1), width: '200px', - maxHeight: '100px', overflow: 'auto', display: 'inline-block', + maxHeight: '95%', }, [`& .${classes.secondaryTail}`]: { backgroundColor: theme.palette.secondary.main, @@ -48,47 +48,107 @@ const StyledTimeLine = styled((props: TimeLinePropsWithRef) => + {event.deps + ? event.deps.map((childId) => { + return NestedEvents(eventStates, childId); + }) + : null} + + ); + } + } + + return null; +} + +function colorDot(phase: Phase | undefined): TimelineDotProps['color'] { + if (phase == null) return 'error'; + + if (phase.final_event_id == null || phase.events == null) return 'grey'; + + const root_event = phase.events[phase.final_event_id]; + if (root_event == null) return 'error'; + + if (root_event.status == null) return 'error'; + + switch (root_event.status) { + case Status.Uninitialized: + case Status.Blocked: + case Status.Error: + case Status.Failed: + return 'error'; + + case Status.Queued: + case Status.Standby: + return 'grey'; + + case Status.Underway: + return 'success'; + + case Status.Skipped: + case Status.Canceled: + case Status.Killed: + return 'secondary'; + + case Status.Delayed: + return 'warning'; + + case Status.Completed: + return 'primary'; + + default: + return 'error'; + } +} + export interface TaskTimelineProps { taskState: TaskState; } +function RenderPhase(phase: Phase) { + return ( + + + + {phase.unix_millis_start_time + ? format(new Date(phase.unix_millis_start_time), "hh:mm:ss aaaaa'm'") + : null} + + + + + + + + + {phase.id}. {phase.category} + + } defaultExpandIcon={}> + {NestedEvents(phase.events, phase.final_event_id)} + + + + ); +} + export function TaskTimeline({ taskState }: TaskTimelineProps): JSX.Element { const phases = taskState.phases ? Object.values(taskState.phases) : []; - return ( - {phases.map((phase, idx) => ( - - - - {phase.unix_millis_start_time - ? new Date(phase.unix_millis_start_time).toLocaleTimeString() - : 'unknown'} - - - - - {idx < phases.length - 1 && } - - - } - defaultExpandIcon={} - > - {/* FIXME: rmf does not return event hierarchy information */} - {phase.events - ? Object.values(phase.events).map((event) => ( - - )) - : null} - - - - ))} + {phases.map((phase) => RenderPhase(phase))} ); } From 55e45c96b0be3b618d4970bec63da522191e7fca Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 16 Feb 2022 10:05:13 +0800 Subject: [PATCH 52/79] fix build error Signed-off-by: Teo Koon Peng --- .../src/util/common-subscriptions.ts | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/packages/dashboard/src/util/common-subscriptions.ts b/packages/dashboard/src/util/common-subscriptions.ts index af8a00662..bdf11f8bb 100644 --- a/packages/dashboard/src/util/common-subscriptions.ts +++ b/packages/dashboard/src/util/common-subscriptions.ts @@ -1,6 +1,6 @@ import React from 'react'; import * as RmfModels from 'rmf-models'; -import { FleetState, SioClient, Ingestor, Dispenser } from 'api-client'; +import { FleetState, SioClient, Ingestor, Dispenser, Subscription } from 'api-client'; import { RmfIngress } from '../components/rmf-app/rmf-ingress'; export const useFleets = ( @@ -25,13 +25,18 @@ export const useFleetStateRef = (sioClient: SioClient | undefined, fleets: Fleet const fleetStatesRef = React.useRef>({}); React.useEffect(() => { if (!sioClient) return; - const subs = fleets.map((f) => - f.name - ? sioClient.subscribeFleetState(f.name, (state) => { - if (f.name) fleetStatesRef.current[f.name] = state; - }) - : () => null, - ); + const subs = fleets.reduce((acc, f) => { + if (!f.name) { + return acc; + } + const fleetName = f.name; + acc.push( + sioClient.subscribeFleetState(fleetName, (state) => { + fleetStatesRef.current[fleetName] = state; + }), + ); + return acc; + }, [] as Subscription[]); return () => { subs.forEach((s) => sioClient.unsubscribe(s)); }; From eaaa3ae3419081b9160a41aa154c623dbb67ac6b Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 16 Feb 2022 11:54:13 +0800 Subject: [PATCH 53/79] fix parsing of dispatch task response Signed-off-by: Teo Koon Peng --- packages/api-server/api_server/routes/tasks/tasks.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/api-server/api_server/routes/tasks/tasks.py b/packages/api-server/api_server/routes/tasks/tasks.py index 106b106dc..b95b38022 100644 --- a/packages/api-server/api_server/routes/tasks/tasks.py +++ b/packages/api-server/api_server/routes/tasks/tasks.py @@ -124,7 +124,7 @@ async def post_dispatch_task( await task_repo.save_task_state( cast(mdl.TaskDispatchResponseItem, resp.__root__).state ) - return resp + return resp.__root__ @router.post("/interrupt_task", response_model=mdl.TaskInterruptionResponse) From 9d79b930b33d80e071c3db1f11d3dcd3ed0f81ce Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 16 Feb 2022 12:07:11 +0800 Subject: [PATCH 54/79] update datamodel codegen Signed-off-by: Teo Koon Peng --- .../models/rmf_api/dispatch_task_response.py | 4 ++-- .../api_server/models/rmf_api/robot_state.py | 4 ++-- .../api_server/models/rmf_api/task_state.py | 12 ++++++------ .../api-server/api_server/models/rmf_api/version.py | 1 + .../api_server/models/rmf_ros2/version.py | 1 + packages/api-server/generate-models.sh | 13 +++++++++---- 6 files changed, 21 insertions(+), 14 deletions(-) diff --git a/packages/api-server/api_server/models/rmf_api/dispatch_task_response.py b/packages/api-server/api_server/models/rmf_api/dispatch_task_response.py index 230627175..a9bd493cc 100644 --- a/packages/api-server/api_server/models/rmf_api/dispatch_task_response.py +++ b/packages/api-server/api_server/models/rmf_api/dispatch_task_response.py @@ -12,14 +12,14 @@ class TaskDispatchResponseItem1(BaseModel): - success: Optional[Literal[0]] = None + success: Optional[Literal[False]] = None errors: Optional[List[error.Error]] = Field( None, description="Any error messages explaining why the request failed" ) class TaskDispatchResponseItem(BaseModel): - success: Literal[1] + success: Literal[True] state: task_state.TaskState diff --git a/packages/api-server/api_server/models/rmf_api/robot_state.py b/packages/api-server/api_server/models/rmf_api/robot_state.py index 070b7b885..b16fff479 100644 --- a/packages/api-server/api_server/models/rmf_api/robot_state.py +++ b/packages/api-server/api_server/models/rmf_api/robot_state.py @@ -11,7 +11,7 @@ from . import location_2D -class Status(Enum): +class Status2(Enum): uninitialized = "uninitialized" offline = "offline" shutdown = "shutdown" @@ -30,7 +30,7 @@ class Issue(BaseModel): class RobotState(BaseModel): name: Optional[str] = None - status: Optional[Status] = Field( + status: Optional[Status2] = Field( None, description="A simple token representing the status of the robot" ) task_id: Optional[str] = Field( diff --git a/packages/api-server/api_server/models/rmf_api/task_state.py b/packages/api-server/api_server/models/rmf_api/task_state.py index b487c0e7b..0494bccb5 100644 --- a/packages/api-server/api_server/models/rmf_api/task_state.py +++ b/packages/api-server/api_server/models/rmf_api/task_state.py @@ -64,12 +64,6 @@ class Assignment(BaseModel): expected_robot_name: Optional[str] = None -class Dispatch(BaseModel): - status: Status1 - assignment: Optional[Assignment] = None - errors: Optional[List[error.Error]] = None - - class EstimateMillis(BaseModel): __root__: conint(ge=0) = Field( ..., @@ -151,6 +145,12 @@ class SkipPhaseRequest(BaseModel): ) +class Dispatch(BaseModel): + status: Status1 + assignment: Optional[Assignment] = None + errors: Optional[List[error.Error]] = None + + class Phase(BaseModel): id: Id category: Optional[Category] = None diff --git a/packages/api-server/api_server/models/rmf_api/version.py b/packages/api-server/api_server/models/rmf_api/version.py index f93096d5d..79086fc9a 100644 --- a/packages/api-server/api_server/models/rmf_api/version.py +++ b/packages/api-server/api_server/models/rmf_api/version.py @@ -1,4 +1,5 @@ # THIS FILE IS GENERATED version = { "rmf_api_msgs": "91295892192d24ec73c9a1c6fa54334963586784", + "datamodel-code-generator": "0.11.19", } diff --git a/packages/api-server/api_server/models/rmf_ros2/version.py b/packages/api-server/api_server/models/rmf_ros2/version.py index 941d347ed..63142b6e6 100644 --- a/packages/api-server/api_server/models/rmf_ros2/version.py +++ b/packages/api-server/api_server/models/rmf_ros2/version.py @@ -1,4 +1,5 @@ # THIS FILE IS GENERATED version = { "rmf_ros2": "bf038461b5b0fb7d4594461a724bc9e5e7cb97c6", + "datamodel-code-generator": "0.11.19", } diff --git a/packages/api-server/generate-models.sh b/packages/api-server/generate-models.sh index 283197571..45d64c833 100755 --- a/packages/api-server/generate-models.sh +++ b/packages/api-server/generate-models.sh @@ -6,6 +6,7 @@ RMF_BUILDING_MAP_MSGS_VER=c5e0352e2dfd3d11e4d292a1c2901cad867c1441 RMF_INTERNAL_MSGS_VER=0c237e1758872917661879975d7dc0acf5fa518c RMF_API_MSGS_VER=91295892192d24ec73c9a1c6fa54334963586784 RMF_ROS2_VER=bf038461b5b0fb7d4594461a724bc9e5e7cb97c6 +CODEGEN_VER=0.11.19 cd "$(dirname $0)" source ../../scripts/rmf-helpers.sh @@ -61,6 +62,12 @@ EOF pipenv run isort api_server/models/ros_pydantic pipenv run black api_server/models/ros_pydantic +# install datamodel-codegen +if [[ ! -d .venv_local/lib ]]; then + python3 -m venv .venv_local +fi +bash -c ". .venv_local/bin/activate && pip3 install wheel && pip3 install 'datamodel-code-generator==${CODEGEN_VER}'" + generate_from_json_schema() { input=$1 output=$2 @@ -69,15 +76,12 @@ generate_from_json_schema() { rm -rf "$output" mkdir -p "$output" - if [[ ! -d .venv_local/lib ]]; then - python3 -m venv .venv_local - bash -c ". .venv_local/bin/activate && pip3 install wheel && pip3 install 'datamodel-code-generator==0.11.17'" - fi bash -c ". .venv_local/bin/activate && datamodel-codegen --disable-timestamp --input-file-type jsonschema --enum-field-as-literal one --input "$input" --output \"$output\"" cat << EOF > "$output/version.py" # THIS FILE IS GENERATED version = { "$upstream": "$version", + "datamodel-code-generator": "${CODEGEN_VER}", } EOF pipenv run isort "$output" @@ -96,5 +100,6 @@ echo " rmf_internal_msgs: $RMF_INTERNAL_MSGS_VER" echo " rmf_building_map_msgs: $RMF_BUILDING_MAP_MSGS_VER" echo " rmf_api_msgs: $RMF_API_MSGS_VER" echo " rmf_ros2: $RMF_ROS2_VER" +echo " datamodel-code-generator: ${CODEGEN_VER}" echo '' echo 'Successfully generated ros_pydantic models' From 1ca61f559298938a4cb9bbf5fa745c9e69f3a37b Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 16 Feb 2022 12:28:49 +0800 Subject: [PATCH 55/79] update openapi gen and models Signed-off-by: Teo Koon Peng --- packages/api-client/generate-openapi.sh | 14 +- .../lib/openapi/.openapi-generator/VERSION | 2 +- packages/api-client/lib/openapi/api.ts | 948 ++++++++++-------- packages/api-client/lib/openapi/base.ts | 4 +- packages/api-client/lib/openapi/common.ts | 9 +- packages/api-client/lib/openapi/git_push.sh | 7 +- packages/api-client/lib/version.ts | 4 +- 7 files changed, 565 insertions(+), 423 deletions(-) diff --git a/packages/api-client/generate-openapi.sh b/packages/api-client/generate-openapi.sh index 44d3d59aa..fec4adcf4 100755 --- a/packages/api-client/generate-openapi.sh +++ b/packages/api-client/generate-openapi.sh @@ -8,25 +8,25 @@ function usage() { cd $(dirname $0) source ../../scripts/version.sh +openapi_generator_ver=5.4.0 -expected_sha='b2d46d4990af3d442e4e228e1e627b93ca371ad972f54a7e82272b0ce7968c8b' +expected_sha='f3ed312310e390324b33ba2ffff290ce812935207a1493ec5c098d0a441be51c' -if [[ ! -f '.bin/openapi-generator-cli-5.2.1.jar' ]]; then +if [[ ! -f ".bin/openapi-generator-cli-${openapi_generator_ver}.jar" ]]; then mkdir -p .bin - wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/5.2.1/openapi-generator-cli-5.2.1.jar -O .bin/openapi-generator-cli-5.2.1.jar + wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/${openapi_generator_ver}/openapi-generator-cli-${openapi_generator_ver}.jar -O .bin/openapi-generator-cli-${openapi_generator_ver}.jar fi -sha=$(sha256sum .bin/openapi-generator-cli-5.2.1.jar | awk '{print $1}') +sha=$(sha256sum .bin/openapi-generator-cli-${openapi_generator_ver}.jar | awk '{print $1}') if [[ $sha != $expected_sha ]]; then - echo "ERR: .bin/openapi-generator-cli-5.2.1.jar sha doesn't match" + echo "ERR: .bin/openapi-generator-cli-${openapi_generator_ver}.jar sha doesn't match" exit 1 fi -openapi_generator_ver=$(java -jar .bin/openapi-generator-cli-5.2.1.jar version) pipenv run python generate-openapi.py rm -rf 'lib/openapi' -java -jar .bin/openapi-generator-cli-5.2.1.jar generate -i'build/openapi.json' -gtypescript-axios -olib/openapi -copenapi-generator.json +java -jar .bin/openapi-generator-cli-${openapi_generator_ver}.jar generate -i'build/openapi.json' -gtypescript-axios -olib/openapi -copenapi-generator.json rmf_server_ver=$(getVersion .) diff --git a/packages/api-client/lib/openapi/.openapi-generator/VERSION b/packages/api-client/lib/openapi/.openapi-generator/VERSION index 804440660..1e20ec35c 100644 --- a/packages/api-client/lib/openapi/.openapi-generator/VERSION +++ b/packages/api-client/lib/openapi/.openapi-generator/VERSION @@ -1 +1 @@ -5.2.1 \ No newline at end of file +5.4.0 \ No newline at end of file diff --git a/packages/api-client/lib/openapi/api.ts b/packages/api-client/lib/openapi/api.ts index ee4496fcb..ee89e5f17 100644 --- a/packages/api-client/lib/openapi/api.ts +++ b/packages/api-client/lib/openapi/api.ts @@ -13,7 +13,7 @@ */ import { Configuration } from './configuration'; -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; +import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { @@ -80,8 +80,16 @@ export interface ActivityDiscoveryRequest { * @type {string} * @memberof ActivityDiscoveryRequest */ - type: string; + type: ActivityDiscoveryRequestTypeEnum; } + +export const ActivityDiscoveryRequestTypeEnum = { + ActivitiyDiscoveryRequest: 'activitiy_discovery_request', +} as const; + +export type ActivityDiscoveryRequestTypeEnum = + typeof ActivityDiscoveryRequestTypeEnum[keyof typeof ActivityDiscoveryRequestTypeEnum]; + /** * * @export @@ -131,6 +139,34 @@ export interface AffineImage { */ data: string; } +/** + * An enumeration. + * @export + * @enum {string} + */ +export type ApiServerModelsRmfApiSimpleResponseFailure = false; + +/** + * An enumeration. + * @export + * @enum {string} + */ +export type ApiServerModelsRmfApiSimpleResponseSuccess = true; + +/** + * An enumeration. + * @export + * @enum {string} + */ +export type ApiServerModelsRmfApiTokenResponseFailure = false; + +/** + * An enumeration. + * @export + * @enum {string} + */ +export type ApiServerModelsRmfApiTokenResponseSuccess = true; + /** * * @export @@ -236,7 +272,7 @@ export interface CancelTaskRequest { * @type {string} * @memberof CancelTaskRequest */ - type: string; + type: CancelTaskRequestTypeEnum; /** * Specify the task ID to cancel * @type {string} @@ -250,6 +286,14 @@ export interface CancelTaskRequest { */ labels?: Array; } + +export const CancelTaskRequestTypeEnum = { + CancelTaskRequest: 'cancel_task_request', +} as const; + +export type CancelTaskRequestTypeEnum = + typeof CancelTaskRequestTypeEnum[keyof typeof CancelTaskRequestTypeEnum]; + /** * * @export @@ -349,7 +393,7 @@ export interface DispatchTaskRequest { * @type {string} * @memberof DispatchTaskRequest */ - type: string; + type: DispatchTaskRequestTypeEnum; /** * * @type {TaskRequest} @@ -357,6 +401,14 @@ export interface DispatchTaskRequest { */ request: TaskRequest; } + +export const DispatchTaskRequestTypeEnum = { + DispatchTaskRequest: 'dispatch_task_request', +} as const; + +export type DispatchTaskRequestTypeEnum = + typeof DispatchTaskRequestTypeEnum[keyof typeof DispatchTaskRequestTypeEnum]; + /** * * @export @@ -1513,11 +1565,11 @@ export interface RobotState { */ export interface SimpleResponse { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiSimpleResponseFailure} * @memberof SimpleResponse */ - success: boolean; + success: ApiServerModelsRmfApiSimpleResponseFailure; /** * If the request failed, these error messages will explain why * @type {Array} @@ -1532,11 +1584,11 @@ export interface SimpleResponse { */ export interface SimpleResponseItem { /** - * The request was successful - * @type {boolean} + * + * @type {ApiServerModelsRmfApiSimpleResponseSuccess} * @memberof SimpleResponseItem */ - success: boolean; + success: ApiServerModelsRmfApiSimpleResponseSuccess; } /** * @@ -1545,11 +1597,11 @@ export interface SimpleResponseItem { */ export interface SimpleResponseItem1 { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiSimpleResponseFailure} * @memberof SimpleResponseItem1 */ - success: boolean; + success: ApiServerModelsRmfApiSimpleResponseFailure; /** * If the request failed, these error messages will explain why * @type {Array} @@ -1589,11 +1641,11 @@ export interface SkipPhaseRequest { */ export interface SkipPhaseResponse { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiTokenResponseFailure} * @memberof SkipPhaseResponse */ - success: boolean; + success: ApiServerModelsRmfApiTokenResponseFailure; /** * A token for the request. The value of this token is unique within the scope of this request and can be used by other requests to reference this request. * @type {string} @@ -1613,20 +1665,22 @@ export interface SkipPhaseResponse { * @enum {string} */ -export enum Status { - Uninitialized = 'uninitialized', - Blocked = 'blocked', - Error = 'error', - Failed = 'failed', - Queued = 'queued', - Standby = 'standby', - Underway = 'underway', - Delayed = 'delayed', - Skipped = 'skipped', - Canceled = 'canceled', - Killed = 'killed', - Completed = 'completed', -} +export const Status = { + Uninitialized: 'uninitialized', + Blocked: 'blocked', + Error: 'error', + Failed: 'failed', + Queued: 'queued', + Standby: 'standby', + Underway: 'underway', + Delayed: 'delayed', + Skipped: 'skipped', + Canceled: 'canceled', + Killed: 'killed', + Completed: 'completed', +} as const; + +export type Status = typeof Status[keyof typeof Status]; /** * An enumeration. @@ -1634,13 +1688,15 @@ export enum Status { * @enum {string} */ -export enum Status1 { - Queued = 'queued', - Selected = 'selected', - Dispatched = 'dispatched', - FailedToAssign = 'failed_to_assign', - CanceledInFlight = 'canceled_in_flight', -} +export const Status1 = { + Queued: 'queued', + Selected: 'selected', + Dispatched: 'dispatched', + FailedToAssign: 'failed_to_assign', + CanceledInFlight: 'canceled_in_flight', +} as const; + +export type Status1 = typeof Status1[keyof typeof Status1]; /** * An enumeration. @@ -1648,15 +1704,17 @@ export enum Status1 { * @enum {string} */ -export enum Status2 { - Uninitialized = 'uninitialized', - Offline = 'offline', - Shutdown = 'shutdown', - Idle = 'idle', - Charging = 'charging', - Working = 'working', - Error = 'error', -} +export const Status2 = { + Uninitialized: 'uninitialized', + Offline: 'offline', + Shutdown: 'shutdown', + Idle: 'idle', + Charging: 'charging', + Working: 'working', + Error: 'error', +} as const; + +export type Status2 = typeof Status2[keyof typeof Status2]; /** * @@ -1690,11 +1748,11 @@ export interface Task { */ export interface TaskCancelResponse { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiSimpleResponseFailure} * @memberof TaskCancelResponse */ - success: boolean; + success: ApiServerModelsRmfApiSimpleResponseFailure; /** * If the request failed, these error messages will explain why * @type {Array} @@ -1713,14 +1771,22 @@ export interface TaskDiscovery { * @type {string} * @memberof TaskDiscovery */ - type?: string; + type: TaskDiscoveryTypeEnum; /** * * @type {Data} * @memberof TaskDiscovery */ - data?: Data; + data: Data; } + +export const TaskDiscoveryTypeEnum = { + TaskDiscoveryUpdate: 'task_discovery_update', +} as const; + +export type TaskDiscoveryTypeEnum = + typeof TaskDiscoveryTypeEnum[keyof typeof TaskDiscoveryTypeEnum]; + /** * * @export @@ -1732,33 +1798,16 @@ export interface TaskDiscoveryRequest { * @type {string} * @memberof TaskDiscoveryRequest */ - type: string; -} -/** - * Response to a task dispatch request - * @export - * @interface TaskDispatchResponse - */ -export interface TaskDispatchResponse { - /** - * - * @type {boolean} - * @memberof TaskDispatchResponse - */ - success: boolean; - /** - * - * @type {TaskState} - * @memberof TaskDispatchResponse - */ - state?: TaskState; - /** - * Any error messages explaining why the request failed - * @type {Array} - * @memberof TaskDispatchResponse - */ - errors?: Array; + type: TaskDiscoveryRequestTypeEnum; } + +export const TaskDiscoveryRequestTypeEnum = { + TaskDiscoveryRequest: 'task_discovery_request', +} as const; + +export type TaskDiscoveryRequestTypeEnum = + typeof TaskDiscoveryRequestTypeEnum[keyof typeof TaskDiscoveryRequestTypeEnum]; + /** * * @export @@ -1770,14 +1819,22 @@ export interface TaskDispatchResponseItem { * @type {boolean} * @memberof TaskDispatchResponseItem */ - success: boolean; + success: TaskDispatchResponseItemSuccessEnum; /** * * @type {TaskState} * @memberof TaskDispatchResponseItem */ - state?: TaskState; + state: TaskState; } + +export const TaskDispatchResponseItemSuccessEnum = { + True: true, +} as const; + +export type TaskDispatchResponseItemSuccessEnum = + typeof TaskDispatchResponseItemSuccessEnum[keyof typeof TaskDispatchResponseItemSuccessEnum]; + /** * * @export @@ -1789,7 +1846,7 @@ export interface TaskDispatchResponseItem1 { * @type {boolean} * @memberof TaskDispatchResponseItem1 */ - success?: boolean; + success?: TaskDispatchResponseItem1SuccessEnum; /** * Any error messages explaining why the request failed * @type {Array} @@ -1797,6 +1854,14 @@ export interface TaskDispatchResponseItem1 { */ errors?: Array; } + +export const TaskDispatchResponseItem1SuccessEnum = { + False: false, +} as const; + +export type TaskDispatchResponseItem1SuccessEnum = + typeof TaskDispatchResponseItem1SuccessEnum[keyof typeof TaskDispatchResponseItem1SuccessEnum]; + /** * * @export @@ -1833,7 +1898,7 @@ export interface TaskInterruptionRequest { * @type {string} * @memberof TaskInterruptionRequest */ - type: string; + type: TaskInterruptionRequestTypeEnum; /** * Specify the task ID to interrupt * @type {string} @@ -1847,6 +1912,14 @@ export interface TaskInterruptionRequest { */ labels?: Array; } + +export const TaskInterruptionRequestTypeEnum = { + InterruptTaskRequest: 'interrupt_task_request', +} as const; + +export type TaskInterruptionRequestTypeEnum = + typeof TaskInterruptionRequestTypeEnum[keyof typeof TaskInterruptionRequestTypeEnum]; + /** * Response to a request for a task to be interrupted * @export @@ -1854,11 +1927,11 @@ export interface TaskInterruptionRequest { */ export interface TaskInterruptionResponse { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiTokenResponseFailure} * @memberof TaskInterruptionResponse */ - success: boolean; + success: ApiServerModelsRmfApiTokenResponseFailure; /** * A token for the request. The value of this token is unique within the scope of this request and can be used by other requests to reference this request. * @type {string} @@ -1883,7 +1956,7 @@ export interface TaskKillRequest { * @type {string} * @memberof TaskKillRequest */ - type: string; + type: TaskKillRequestTypeEnum; /** * Specify the task ID to kill * @type {string} @@ -1897,6 +1970,14 @@ export interface TaskKillRequest { */ labels?: Array; } + +export const TaskKillRequestTypeEnum = { + KillTaskRequest: 'kill_task_request', +} as const; + +export type TaskKillRequestTypeEnum = + typeof TaskKillRequestTypeEnum[keyof typeof TaskKillRequestTypeEnum]; + /** * Response to a request to kill a task * @export @@ -1904,11 +1985,11 @@ export interface TaskKillRequest { */ export interface TaskKillResponse { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiSimpleResponseFailure} * @memberof TaskKillResponse */ - success: boolean; + success: ApiServerModelsRmfApiSimpleResponseFailure; /** * If the request failed, these error messages will explain why * @type {Array} @@ -1927,7 +2008,7 @@ export interface TaskPhaseSkipRequest { * @type {string} * @memberof TaskPhaseSkipRequest */ - type: string; + type: TaskPhaseSkipRequestTypeEnum; /** * Specify the task ID whose phase should be skipped * @type {string} @@ -1947,6 +2028,14 @@ export interface TaskPhaseSkipRequest { */ labels?: Array; } + +export const TaskPhaseSkipRequestTypeEnum = { + SkipPhaseRequest: 'skip_phase_request', +} as const; + +export type TaskPhaseSkipRequestTypeEnum = + typeof TaskPhaseSkipRequestTypeEnum[keyof typeof TaskPhaseSkipRequestTypeEnum]; + /** * * @export @@ -1976,7 +2065,7 @@ export interface TaskRequest { * @type {any} * @memberof TaskRequest */ - description: any | null; + description: any; /** * Labels to describe the purpose of the task dispatch request * @type {Array} @@ -1995,7 +2084,7 @@ export interface TaskResumeRequest { * @type {string} * @memberof TaskResumeRequest */ - type?: string; + type?: TaskResumeRequestTypeEnum; /** * Specify task ID to resume. * @type {string} @@ -2015,6 +2104,14 @@ export interface TaskResumeRequest { */ labels?: Array; } + +export const TaskResumeRequestTypeEnum = { + ResumeTaskRequest: 'resume_task_request', +} as const; + +export type TaskResumeRequestTypeEnum = + typeof TaskResumeRequestTypeEnum[keyof typeof TaskResumeRequestTypeEnum]; + /** * Response to a request to resume a task * @export @@ -2022,11 +2119,11 @@ export interface TaskResumeRequest { */ export interface TaskResumeResponse { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiSimpleResponseFailure} * @memberof TaskResumeResponse */ - success: boolean; + success: ApiServerModelsRmfApiSimpleResponseFailure; /** * If the request failed, these error messages will explain why * @type {Array} @@ -2045,7 +2142,7 @@ export interface TaskRewindRequest { * @type {string} * @memberof TaskRewindRequest */ - type: string; + type: TaskRewindRequestTypeEnum; /** * Specify the ID of the task that should rewind * @type {string} @@ -2059,6 +2156,14 @@ export interface TaskRewindRequest { */ phase_id: number; } + +export const TaskRewindRequestTypeEnum = { + RewindTaskRequest: 'rewind_task_request', +} as const; + +export type TaskRewindRequestTypeEnum = + typeof TaskRewindRequestTypeEnum[keyof typeof TaskRewindRequestTypeEnum]; + /** * Response to a request to rewind a task * @export @@ -2066,11 +2171,11 @@ export interface TaskRewindRequest { */ export interface TaskRewindResponse { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiSimpleResponseFailure} * @memberof TaskRewindResponse */ - success: boolean; + success: ApiServerModelsRmfApiSimpleResponseFailure; /** * If the request failed, these error messages will explain why * @type {Array} @@ -2193,12 +2298,14 @@ export interface TaskState { * @enum {string} */ -export enum Tier { - Uninitialized = 'uninitialized', - Info = 'info', - Warning = 'warning', - Error = 'error', -} +export const Tier = { + Uninitialized: 'uninitialized', + Info: 'info', + Warning: 'warning', + Error: 'error', +} as const; + +export type Tier = typeof Tier[keyof typeof Tier]; /** * @@ -2226,11 +2333,11 @@ export interface Time { */ export interface TokenResponse { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiTokenResponseFailure} * @memberof TokenResponse */ - success: boolean; + success: ApiServerModelsRmfApiTokenResponseFailure; /** * A token for the request. The value of this token is unique within the scope of this request and can be used by other requests to reference this request. * @type {string} @@ -2251,11 +2358,11 @@ export interface TokenResponse { */ export interface TokenResponseItem { /** - * The request was successful - * @type {boolean} + * + * @type {ApiServerModelsRmfApiTokenResponseSuccess} * @memberof TokenResponseItem */ - success: boolean; + success: ApiServerModelsRmfApiTokenResponseSuccess; /** * A token for the request. The value of this token is unique within the scope of this request and can be used by other requests to reference this request. * @type {string} @@ -2270,11 +2377,11 @@ export interface TokenResponseItem { */ export interface TokenResponseItem1 { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiTokenResponseFailure} * @memberof TokenResponseItem1 */ - success: boolean; + success: ApiServerModelsRmfApiTokenResponseFailure; /** * Any error messages explaining why the request failed. * @type {Array} @@ -2312,7 +2419,7 @@ export interface UndoPhaseSkipRequest { * @type {string} * @memberof UndoPhaseSkipRequest */ - type?: string; + type?: UndoPhaseSkipRequestTypeEnum; /** * Specify the relevant task ID * @type {string} @@ -2332,6 +2439,14 @@ export interface UndoPhaseSkipRequest { */ labels?: Array; } + +export const UndoPhaseSkipRequestTypeEnum = { + UndoPhaseSkipRequest: 'undo_phase_skip_request', +} as const; + +export type UndoPhaseSkipRequestTypeEnum = + typeof UndoPhaseSkipRequestTypeEnum[keyof typeof UndoPhaseSkipRequestTypeEnum]; + /** * Response to an undo phase skip request * @export @@ -2339,11 +2454,11 @@ export interface UndoPhaseSkipRequest { */ export interface UndoPhaseSkipResponse { /** - * The request failed - * @type {boolean} + * + * @type {ApiServerModelsRmfApiSimpleResponseFailure} * @memberof UndoPhaseSkipResponse */ - success: boolean; + success: ApiServerModelsRmfApiSimpleResponseFailure; /** * If the request failed, these error messages will explain why * @type {Array} @@ -2419,7 +2534,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration addRolePermissionAdminRolesRolePermissionsPost: async ( role: string, permission: Permission, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'role' is not null or undefined assertParamExists('addRolePermissionAdminRolesRolePermissionsPost', 'role', role); @@ -2442,7 +2557,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2471,7 +2586,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration addUserRoleAdminUsersUsernameRolesPost: async ( username: string, postRoles: PostRoles, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'username' is not null or undefined assertParamExists('addUserRoleAdminUsersUsernameRolesPost', 'username', username); @@ -2494,7 +2609,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2521,7 +2636,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration */ createRoleAdminRolesPost: async ( postRoles: PostRoles, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'postRoles' is not null or undefined assertParamExists('createRoleAdminRolesPost', 'postRoles', postRoles); @@ -2539,7 +2654,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2566,7 +2681,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration */ createUserAdminUsersPost: async ( postUsers: PostUsers, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'postUsers' is not null or undefined assertParamExists('createUserAdminUsersPost', 'postUsers', postUsers); @@ -2584,7 +2699,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2611,7 +2726,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration */ deleteRoleAdminRolesRoleDelete: async ( role: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'role' is not null or undefined assertParamExists('deleteRoleAdminRolesRoleDelete', 'role', role); @@ -2630,7 +2745,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2652,7 +2767,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration */ deleteUserAdminUsersUsernameDelete: async ( username: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'username' is not null or undefined assertParamExists('deleteUserAdminUsersUsernameDelete', 'username', username); @@ -2671,7 +2786,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2695,7 +2810,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration deleteUserRoleAdminUsersUsernameRolesRoleDelete: async ( username: string, role: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'username' is not null or undefined assertParamExists('deleteUserRoleAdminUsersUsernameRolesRoleDelete', 'username', username); @@ -2715,7 +2830,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2737,7 +2852,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration */ getRolePermissionsAdminRolesRolePermissionsGet: async ( role: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'role' is not null or undefined assertParamExists('getRolePermissionsAdminRolesRolePermissionsGet', 'role', role); @@ -2756,7 +2871,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2775,7 +2890,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getRolesAdminRolesGet: async (options: any = {}): Promise => { + getRolesAdminRolesGet: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/admin/roles`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -2788,7 +2903,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2810,7 +2925,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration */ getUserAdminUsersUsernameGet: async ( username: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'username' is not null or undefined assertParamExists('getUserAdminUsersUsernameGet', 'username', username); @@ -2829,7 +2944,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2859,7 +2974,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration limit?: number, offset?: number, orderBy?: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { const localVarPath = `/admin/users`; // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -2893,7 +3008,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['order_by'] = orderBy; } - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2917,7 +3032,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration makeAdminAdminUsersUsernameMakeAdminPost: async ( username: string, postMakeAdmin: PostMakeAdmin, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'username' is not null or undefined assertParamExists('makeAdminAdminUsersUsernameMakeAdminPost', 'username', username); @@ -2940,7 +3055,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -2969,7 +3084,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration removeRolePermissionAdminRolesRolePermissionsRemovePost: async ( role: string, permission: Permission, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'role' is not null or undefined assertParamExists('removeRolePermissionAdminRolesRolePermissionsRemovePost', 'role', role); @@ -2996,7 +3111,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -3025,7 +3140,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration setUserRolesAdminUsersUsernameRolesPut: async ( username: string, postRoles: Array, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'username' is not null or undefined assertParamExists('setUserRolesAdminUsersUsernameRolesPut', 'username', username); @@ -3048,7 +3163,7 @@ export const AdminApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -3087,7 +3202,7 @@ export const AdminApiFp = function (configuration?: Configuration) { async addRolePermissionAdminRolesRolePermissionsPost( role: string, permission: Permission, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.addRolePermissionAdminRolesRolePermissionsPost( @@ -3108,7 +3223,7 @@ export const AdminApiFp = function (configuration?: Configuration) { async addUserRoleAdminUsersUsernameRolesPost( username: string, postRoles: PostRoles, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.addUserRoleAdminUsersUsernameRolesPost( @@ -3127,7 +3242,7 @@ export const AdminApiFp = function (configuration?: Configuration) { */ async createRoleAdminRolesPost( postRoles: PostRoles, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createRoleAdminRolesPost( postRoles, @@ -3144,7 +3259,7 @@ export const AdminApiFp = function (configuration?: Configuration) { */ async createUserAdminUsersPost( postUsers: PostUsers, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.createUserAdminUsersPost( postUsers, @@ -3161,7 +3276,7 @@ export const AdminApiFp = function (configuration?: Configuration) { */ async deleteRoleAdminRolesRoleDelete( role: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteRoleAdminRolesRoleDelete( role, @@ -3178,7 +3293,7 @@ export const AdminApiFp = function (configuration?: Configuration) { */ async deleteUserAdminUsersUsernameDelete( username: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserAdminUsersUsernameDelete( username, @@ -3197,7 +3312,7 @@ export const AdminApiFp = function (configuration?: Configuration) { async deleteUserRoleAdminUsersUsernameRolesRoleDelete( username: string, role: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.deleteUserRoleAdminUsersUsernameRolesRoleDelete( @@ -3216,7 +3331,7 @@ export const AdminApiFp = function (configuration?: Configuration) { */ async getRolePermissionsAdminRolesRolePermissionsGet( role: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRolePermissionsAdminRolesRolePermissionsGet( @@ -3232,7 +3347,7 @@ export const AdminApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async getRolesAdminRolesGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getRolesAdminRolesGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -3246,7 +3361,7 @@ export const AdminApiFp = function (configuration?: Configuration) { */ async getUserAdminUsersUsernameGet( username: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getUserAdminUsersUsernameGet( username, @@ -3271,7 +3386,7 @@ export const AdminApiFp = function (configuration?: Configuration) { limit?: number, offset?: number, orderBy?: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getUsersAdminUsersGet( username, @@ -3294,7 +3409,7 @@ export const AdminApiFp = function (configuration?: Configuration) { async makeAdminAdminUsersUsernameMakeAdminPost( username: string, postMakeAdmin: PostMakeAdmin, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.makeAdminAdminUsersUsernameMakeAdminPost( @@ -3315,7 +3430,7 @@ export const AdminApiFp = function (configuration?: Configuration) { async removeRolePermissionAdminRolesRolePermissionsRemovePost( role: string, permission: Permission, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.removeRolePermissionAdminRolesRolePermissionsRemovePost( @@ -3336,7 +3451,7 @@ export const AdminApiFp = function (configuration?: Configuration) { async setUserRolesAdminUsersUsernameRolesPut( username: string, postRoles: Array, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.setUserRolesAdminUsersUsernameRolesPut( @@ -3591,7 +3706,7 @@ export class AdminApi extends BaseAPI { public addRolePermissionAdminRolesRolePermissionsPost( role: string, permission: Permission, - options?: any, + options?: AxiosRequestConfig, ) { return AdminApiFp(this.configuration) .addRolePermissionAdminRolesRolePermissionsPost(role, permission, options) @@ -3610,7 +3725,7 @@ export class AdminApi extends BaseAPI { public addUserRoleAdminUsersUsernameRolesPost( username: string, postRoles: PostRoles, - options?: any, + options?: AxiosRequestConfig, ) { return AdminApiFp(this.configuration) .addUserRoleAdminUsersUsernameRolesPost(username, postRoles, options) @@ -3625,7 +3740,7 @@ export class AdminApi extends BaseAPI { * @throws {RequiredError} * @memberof AdminApi */ - public createRoleAdminRolesPost(postRoles: PostRoles, options?: any) { + public createRoleAdminRolesPost(postRoles: PostRoles, options?: AxiosRequestConfig) { return AdminApiFp(this.configuration) .createRoleAdminRolesPost(postRoles, options) .then((request) => request(this.axios, this.basePath)); @@ -3639,7 +3754,7 @@ export class AdminApi extends BaseAPI { * @throws {RequiredError} * @memberof AdminApi */ - public createUserAdminUsersPost(postUsers: PostUsers, options?: any) { + public createUserAdminUsersPost(postUsers: PostUsers, options?: AxiosRequestConfig) { return AdminApiFp(this.configuration) .createUserAdminUsersPost(postUsers, options) .then((request) => request(this.axios, this.basePath)); @@ -3653,7 +3768,7 @@ export class AdminApi extends BaseAPI { * @throws {RequiredError} * @memberof AdminApi */ - public deleteRoleAdminRolesRoleDelete(role: string, options?: any) { + public deleteRoleAdminRolesRoleDelete(role: string, options?: AxiosRequestConfig) { return AdminApiFp(this.configuration) .deleteRoleAdminRolesRoleDelete(role, options) .then((request) => request(this.axios, this.basePath)); @@ -3667,7 +3782,7 @@ export class AdminApi extends BaseAPI { * @throws {RequiredError} * @memberof AdminApi */ - public deleteUserAdminUsersUsernameDelete(username: string, options?: any) { + public deleteUserAdminUsersUsernameDelete(username: string, options?: AxiosRequestConfig) { return AdminApiFp(this.configuration) .deleteUserAdminUsersUsernameDelete(username, options) .then((request) => request(this.axios, this.basePath)); @@ -3685,7 +3800,7 @@ export class AdminApi extends BaseAPI { public deleteUserRoleAdminUsersUsernameRolesRoleDelete( username: string, role: string, - options?: any, + options?: AxiosRequestConfig, ) { return AdminApiFp(this.configuration) .deleteUserRoleAdminUsersUsernameRolesRoleDelete(username, role, options) @@ -3700,7 +3815,10 @@ export class AdminApi extends BaseAPI { * @throws {RequiredError} * @memberof AdminApi */ - public getRolePermissionsAdminRolesRolePermissionsGet(role: string, options?: any) { + public getRolePermissionsAdminRolesRolePermissionsGet( + role: string, + options?: AxiosRequestConfig, + ) { return AdminApiFp(this.configuration) .getRolePermissionsAdminRolesRolePermissionsGet(role, options) .then((request) => request(this.axios, this.basePath)); @@ -3713,7 +3831,7 @@ export class AdminApi extends BaseAPI { * @throws {RequiredError} * @memberof AdminApi */ - public getRolesAdminRolesGet(options?: any) { + public getRolesAdminRolesGet(options?: AxiosRequestConfig) { return AdminApiFp(this.configuration) .getRolesAdminRolesGet(options) .then((request) => request(this.axios, this.basePath)); @@ -3727,7 +3845,7 @@ export class AdminApi extends BaseAPI { * @throws {RequiredError} * @memberof AdminApi */ - public getUserAdminUsersUsernameGet(username: string, options?: any) { + public getUserAdminUsersUsernameGet(username: string, options?: AxiosRequestConfig) { return AdminApiFp(this.configuration) .getUserAdminUsersUsernameGet(username, options) .then((request) => request(this.axios, this.basePath)); @@ -3751,7 +3869,7 @@ export class AdminApi extends BaseAPI { limit?: number, offset?: number, orderBy?: string, - options?: any, + options?: AxiosRequestConfig, ) { return AdminApiFp(this.configuration) .getUsersAdminUsersGet(username, isAdmin, limit, offset, orderBy, options) @@ -3770,7 +3888,7 @@ export class AdminApi extends BaseAPI { public makeAdminAdminUsersUsernameMakeAdminPost( username: string, postMakeAdmin: PostMakeAdmin, - options?: any, + options?: AxiosRequestConfig, ) { return AdminApiFp(this.configuration) .makeAdminAdminUsersUsernameMakeAdminPost(username, postMakeAdmin, options) @@ -3789,7 +3907,7 @@ export class AdminApi extends BaseAPI { public removeRolePermissionAdminRolesRolePermissionsRemovePost( role: string, permission: Permission, - options?: any, + options?: AxiosRequestConfig, ) { return AdminApiFp(this.configuration) .removeRolePermissionAdminRolesRolePermissionsRemovePost(role, permission, options) @@ -3808,7 +3926,7 @@ export class AdminApi extends BaseAPI { public setUserRolesAdminUsersUsernameRolesPut( username: string, postRoles: Array, - options?: any, + options?: AxiosRequestConfig, ) { return AdminApiFp(this.configuration) .setUserRolesAdminUsersUsernameRolesPut(username, postRoles, options) @@ -3828,7 +3946,9 @@ export const BuildingApiAxiosParamCreator = function (configuration?: Configurat * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getBuildingMapBuildingMapGet: async (options: any = {}): Promise => { + getBuildingMapBuildingMapGet: async ( + options: AxiosRequestConfig = {}, + ): Promise => { const localVarPath = `/building_map`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -3841,7 +3961,7 @@ export const BuildingApiAxiosParamCreator = function (configuration?: Configurat const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -3871,7 +3991,7 @@ export const BuildingApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async getBuildingMapBuildingMapGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getBuildingMapBuildingMapGet( options, @@ -3920,7 +4040,7 @@ export class BuildingApi extends BaseAPI { * @throws {RequiredError} * @memberof BuildingApi */ - public getBuildingMapBuildingMapGet(options?: any) { + public getBuildingMapBuildingMapGet(options?: AxiosRequestConfig) { return BuildingApiFp(this.configuration) .getBuildingMapBuildingMapGet(options) .then((request) => request(this.axios, this.basePath)); @@ -3939,7 +4059,9 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getEffectivePermissionsPermissionsGet: async (options: any = {}): Promise => { + getEffectivePermissionsPermissionsGet: async ( + options: AxiosRequestConfig = {}, + ): Promise => { const localVarPath = `/permissions`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -3952,7 +4074,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -3971,7 +4093,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getUserUserGet: async (options: any = {}): Promise => { + getUserUserGet: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/user`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -3984,7 +4106,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4003,7 +4125,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - lambdaSocketIoGet: async (options: any = {}): Promise => { + lambdaSocketIoGet: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/socket.io`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -4016,7 +4138,7 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4046,7 +4168,7 @@ export const DefaultApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async getEffectivePermissionsPermissionsGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getEffectivePermissionsPermissionsGet(options); @@ -4059,7 +4181,7 @@ export const DefaultApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async getUserUserGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getUserUserGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -4071,7 +4193,7 @@ export const DefaultApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async lambdaSocketIoGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.lambdaSocketIoGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -4136,7 +4258,7 @@ export class DefaultApi extends BaseAPI { * @throws {RequiredError} * @memberof DefaultApi */ - public getEffectivePermissionsPermissionsGet(options?: any) { + public getEffectivePermissionsPermissionsGet(options?: AxiosRequestConfig) { return DefaultApiFp(this.configuration) .getEffectivePermissionsPermissionsGet(options) .then((request) => request(this.axios, this.basePath)); @@ -4149,7 +4271,7 @@ export class DefaultApi extends BaseAPI { * @throws {RequiredError} * @memberof DefaultApi */ - public getUserUserGet(options?: any) { + public getUserUserGet(options?: AxiosRequestConfig) { return DefaultApiFp(this.configuration) .getUserUserGet(options) .then((request) => request(this.axios, this.basePath)); @@ -4162,7 +4284,7 @@ export class DefaultApi extends BaseAPI { * @throws {RequiredError} * @memberof DefaultApi */ - public lambdaSocketIoGet(options?: any) { + public lambdaSocketIoGet(options?: AxiosRequestConfig) { return DefaultApiFp(this.configuration) .lambdaSocketIoGet(options) .then((request) => request(this.axios, this.basePath)); @@ -4184,7 +4306,7 @@ export const DispensersApiAxiosParamCreator = function (configuration?: Configur */ getDispenserHealthDispensersGuidHealthGet: async ( guid: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'guid' is not null or undefined assertParamExists('getDispenserHealthDispensersGuidHealthGet', 'guid', guid); @@ -4203,7 +4325,7 @@ export const DispensersApiAxiosParamCreator = function (configuration?: Configur const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4225,7 +4347,7 @@ export const DispensersApiAxiosParamCreator = function (configuration?: Configur */ getDispenserStateDispensersGuidStateGet: async ( guid: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'guid' is not null or undefined assertParamExists('getDispenserStateDispensersGuidStateGet', 'guid', guid); @@ -4244,7 +4366,7 @@ export const DispensersApiAxiosParamCreator = function (configuration?: Configur const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4263,7 +4385,7 @@ export const DispensersApiAxiosParamCreator = function (configuration?: Configur * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDispensersDispensersGet: async (options: any = {}): Promise => { + getDispensersDispensersGet: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/dispensers`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -4276,7 +4398,7 @@ export const DispensersApiAxiosParamCreator = function (configuration?: Configur const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4308,7 +4430,7 @@ export const DispensersApiFp = function (configuration?: Configuration) { */ async getDispenserHealthDispensersGuidHealthGet( guid: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDispenserHealthDispensersGuidHealthGet(guid, options); @@ -4323,7 +4445,7 @@ export const DispensersApiFp = function (configuration?: Configuration) { */ async getDispenserStateDispensersGuidStateGet( guid: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDispenserStateDispensersGuidStateGet(guid, options); @@ -4336,7 +4458,7 @@ export const DispensersApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async getDispensersDispensersGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDispensersDispensersGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -4414,7 +4536,7 @@ export class DispensersApi extends BaseAPI { * @throws {RequiredError} * @memberof DispensersApi */ - public getDispenserHealthDispensersGuidHealthGet(guid: string, options?: any) { + public getDispenserHealthDispensersGuidHealthGet(guid: string, options?: AxiosRequestConfig) { return DispensersApiFp(this.configuration) .getDispenserHealthDispensersGuidHealthGet(guid, options) .then((request) => request(this.axios, this.basePath)); @@ -4428,7 +4550,7 @@ export class DispensersApi extends BaseAPI { * @throws {RequiredError} * @memberof DispensersApi */ - public getDispenserStateDispensersGuidStateGet(guid: string, options?: any) { + public getDispenserStateDispensersGuidStateGet(guid: string, options?: AxiosRequestConfig) { return DispensersApiFp(this.configuration) .getDispenserStateDispensersGuidStateGet(guid, options) .then((request) => request(this.axios, this.basePath)); @@ -4441,7 +4563,7 @@ export class DispensersApi extends BaseAPI { * @throws {RequiredError} * @memberof DispensersApi */ - public getDispensersDispensersGet(options?: any) { + public getDispensersDispensersGet(options?: AxiosRequestConfig) { return DispensersApiFp(this.configuration) .getDispensersDispensersGet(options) .then((request) => request(this.axios, this.basePath)); @@ -4463,7 +4585,7 @@ export const DoorsApiAxiosParamCreator = function (configuration?: Configuration */ getDoorHealthDoorsDoorNameHealthGet: async ( doorName: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'doorName' is not null or undefined assertParamExists('getDoorHealthDoorsDoorNameHealthGet', 'doorName', doorName); @@ -4482,7 +4604,7 @@ export const DoorsApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4504,7 +4626,7 @@ export const DoorsApiAxiosParamCreator = function (configuration?: Configuration */ getDoorStateDoorsDoorNameStateGet: async ( doorName: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'doorName' is not null or undefined assertParamExists('getDoorStateDoorsDoorNameStateGet', 'doorName', doorName); @@ -4523,7 +4645,7 @@ export const DoorsApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4542,7 +4664,7 @@ export const DoorsApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getDoorsDoorsGet: async (options: any = {}): Promise => { + getDoorsDoorsGet: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/doors`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -4555,7 +4677,7 @@ export const DoorsApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4579,7 +4701,7 @@ export const DoorsApiAxiosParamCreator = function (configuration?: Configuration postDoorRequestDoorsDoorNameRequestPost: async ( doorName: string, doorRequest: DoorRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'doorName' is not null or undefined assertParamExists('postDoorRequestDoorsDoorNameRequestPost', 'doorName', doorName); @@ -4602,7 +4724,7 @@ export const DoorsApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4639,7 +4761,7 @@ export const DoorsApiFp = function (configuration?: Configuration) { */ async getDoorHealthDoorsDoorNameHealthGet( doorName: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDoorHealthDoorsDoorNameHealthGet( doorName, @@ -4656,7 +4778,7 @@ export const DoorsApiFp = function (configuration?: Configuration) { */ async getDoorStateDoorsDoorNameStateGet( doorName: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDoorStateDoorsDoorNameStateGet( doorName, @@ -4671,7 +4793,7 @@ export const DoorsApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async getDoorsDoorsGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getDoorsDoorsGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -4687,7 +4809,7 @@ export const DoorsApiFp = function (configuration?: Configuration) { async postDoorRequestDoorsDoorNameRequestPost( doorName: string, doorRequest: DoorRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postDoorRequestDoorsDoorNameRequestPost( @@ -4779,7 +4901,7 @@ export class DoorsApi extends BaseAPI { * @throws {RequiredError} * @memberof DoorsApi */ - public getDoorHealthDoorsDoorNameHealthGet(doorName: string, options?: any) { + public getDoorHealthDoorsDoorNameHealthGet(doorName: string, options?: AxiosRequestConfig) { return DoorsApiFp(this.configuration) .getDoorHealthDoorsDoorNameHealthGet(doorName, options) .then((request) => request(this.axios, this.basePath)); @@ -4793,7 +4915,7 @@ export class DoorsApi extends BaseAPI { * @throws {RequiredError} * @memberof DoorsApi */ - public getDoorStateDoorsDoorNameStateGet(doorName: string, options?: any) { + public getDoorStateDoorsDoorNameStateGet(doorName: string, options?: AxiosRequestConfig) { return DoorsApiFp(this.configuration) .getDoorStateDoorsDoorNameStateGet(doorName, options) .then((request) => request(this.axios, this.basePath)); @@ -4806,7 +4928,7 @@ export class DoorsApi extends BaseAPI { * @throws {RequiredError} * @memberof DoorsApi */ - public getDoorsDoorsGet(options?: any) { + public getDoorsDoorsGet(options?: AxiosRequestConfig) { return DoorsApiFp(this.configuration) .getDoorsDoorsGet(options) .then((request) => request(this.axios, this.basePath)); @@ -4824,7 +4946,7 @@ export class DoorsApi extends BaseAPI { public postDoorRequestDoorsDoorNameRequestPost( doorName: string, doorRequest: DoorRequest, - options?: any, + options?: AxiosRequestConfig, ) { return DoorsApiFp(this.configuration) .postDoorRequestDoorsDoorNameRequestPost(doorName, doorRequest, options) @@ -4849,7 +4971,7 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio getFleetLogFleetsNameLogGet: async ( name: string, between?: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getFleetLogFleetsNameLogGet', 'name', name); @@ -4872,7 +4994,7 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio localVarQueryParameter['between'] = between; } - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4894,7 +5016,7 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio */ getFleetStateFleetsNameStateGet: async ( name: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'name' is not null or undefined assertParamExists('getFleetStateFleetsNameStateGet', 'name', name); @@ -4913,7 +5035,7 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4932,7 +5054,7 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFleetsFleetsGet: async (options: any = {}): Promise => { + getFleetsFleetsGet: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/fleets`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -4945,7 +5067,7 @@ export const FleetsApiAxiosParamCreator = function (configuration?: Configuratio const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -4979,7 +5101,7 @@ export const FleetsApiFp = function (configuration?: Configuration) { async getFleetLogFleetsNameLogGet( name: string, between?: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getFleetLogFleetsNameLogGet( name, @@ -4997,7 +5119,7 @@ export const FleetsApiFp = function (configuration?: Configuration) { */ async getFleetStateFleetsNameStateGet( name: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getFleetStateFleetsNameStateGet( name, @@ -5012,7 +5134,7 @@ export const FleetsApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async getFleetsFleetsGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getFleetsFleetsGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -5088,7 +5210,7 @@ export class FleetsApi extends BaseAPI { * @throws {RequiredError} * @memberof FleetsApi */ - public getFleetLogFleetsNameLogGet(name: string, between?: string, options?: any) { + public getFleetLogFleetsNameLogGet(name: string, between?: string, options?: AxiosRequestConfig) { return FleetsApiFp(this.configuration) .getFleetLogFleetsNameLogGet(name, between, options) .then((request) => request(this.axios, this.basePath)); @@ -5102,7 +5224,7 @@ export class FleetsApi extends BaseAPI { * @throws {RequiredError} * @memberof FleetsApi */ - public getFleetStateFleetsNameStateGet(name: string, options?: any) { + public getFleetStateFleetsNameStateGet(name: string, options?: AxiosRequestConfig) { return FleetsApiFp(this.configuration) .getFleetStateFleetsNameStateGet(name, options) .then((request) => request(this.axios, this.basePath)); @@ -5115,7 +5237,7 @@ export class FleetsApi extends BaseAPI { * @throws {RequiredError} * @memberof FleetsApi */ - public getFleetsFleetsGet(options?: any) { + public getFleetsFleetsGet(options?: AxiosRequestConfig) { return FleetsApiFp(this.configuration) .getFleetsFleetsGet(options) .then((request) => request(this.axios, this.basePath)); @@ -5137,7 +5259,7 @@ export const IngestorsApiAxiosParamCreator = function (configuration?: Configura */ getIngestorHealthIngestorsGuidHealthGet: async ( guid: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'guid' is not null or undefined assertParamExists('getIngestorHealthIngestorsGuidHealthGet', 'guid', guid); @@ -5156,7 +5278,7 @@ export const IngestorsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5178,7 +5300,7 @@ export const IngestorsApiAxiosParamCreator = function (configuration?: Configura */ getIngestorStateIngestorsGuidStateGet: async ( guid: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'guid' is not null or undefined assertParamExists('getIngestorStateIngestorsGuidStateGet', 'guid', guid); @@ -5197,7 +5319,7 @@ export const IngestorsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5216,7 +5338,7 @@ export const IngestorsApiAxiosParamCreator = function (configuration?: Configura * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getIngestorsIngestorsGet: async (options: any = {}): Promise => { + getIngestorsIngestorsGet: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/ingestors`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -5229,7 +5351,7 @@ export const IngestorsApiAxiosParamCreator = function (configuration?: Configura const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5261,7 +5383,7 @@ export const IngestorsApiFp = function (configuration?: Configuration) { */ async getIngestorHealthIngestorsGuidHealthGet( guid: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIngestorHealthIngestorsGuidHealthGet(guid, options); @@ -5276,7 +5398,7 @@ export const IngestorsApiFp = function (configuration?: Configuration) { */ async getIngestorStateIngestorsGuidStateGet( guid: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIngestorStateIngestorsGuidStateGet(guid, options); @@ -5289,7 +5411,7 @@ export const IngestorsApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async getIngestorsIngestorsGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getIngestorsIngestorsGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -5367,7 +5489,7 @@ export class IngestorsApi extends BaseAPI { * @throws {RequiredError} * @memberof IngestorsApi */ - public getIngestorHealthIngestorsGuidHealthGet(guid: string, options?: any) { + public getIngestorHealthIngestorsGuidHealthGet(guid: string, options?: AxiosRequestConfig) { return IngestorsApiFp(this.configuration) .getIngestorHealthIngestorsGuidHealthGet(guid, options) .then((request) => request(this.axios, this.basePath)); @@ -5381,7 +5503,7 @@ export class IngestorsApi extends BaseAPI { * @throws {RequiredError} * @memberof IngestorsApi */ - public getIngestorStateIngestorsGuidStateGet(guid: string, options?: any) { + public getIngestorStateIngestorsGuidStateGet(guid: string, options?: AxiosRequestConfig) { return IngestorsApiFp(this.configuration) .getIngestorStateIngestorsGuidStateGet(guid, options) .then((request) => request(this.axios, this.basePath)); @@ -5394,7 +5516,7 @@ export class IngestorsApi extends BaseAPI { * @throws {RequiredError} * @memberof IngestorsApi */ - public getIngestorsIngestorsGet(options?: any) { + public getIngestorsIngestorsGet(options?: AxiosRequestConfig) { return IngestorsApiFp(this.configuration) .getIngestorsIngestorsGet(options) .then((request) => request(this.axios, this.basePath)); @@ -5416,7 +5538,7 @@ export const LiftsApiAxiosParamCreator = function (configuration?: Configuration */ getLiftHealthLiftsLiftNameHealthGet: async ( liftName: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'liftName' is not null or undefined assertParamExists('getLiftHealthLiftsLiftNameHealthGet', 'liftName', liftName); @@ -5435,7 +5557,7 @@ export const LiftsApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5457,7 +5579,7 @@ export const LiftsApiAxiosParamCreator = function (configuration?: Configuration */ getLiftStateLiftsLiftNameStateGet: async ( liftName: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'liftName' is not null or undefined assertParamExists('getLiftStateLiftsLiftNameStateGet', 'liftName', liftName); @@ -5476,7 +5598,7 @@ export const LiftsApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5495,7 +5617,7 @@ export const LiftsApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getLiftsLiftsGet: async (options: any = {}): Promise => { + getLiftsLiftsGet: async (options: AxiosRequestConfig = {}): Promise => { const localVarPath = `/lifts`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -5508,7 +5630,7 @@ export const LiftsApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5532,7 +5654,7 @@ export const LiftsApiAxiosParamCreator = function (configuration?: Configuration postLiftRequestLiftsLiftNameRequestPost: async ( liftName: string, liftRequest: LiftRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'liftName' is not null or undefined assertParamExists('postLiftRequestLiftsLiftNameRequestPost', 'liftName', liftName); @@ -5555,7 +5677,7 @@ export const LiftsApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5592,7 +5714,7 @@ export const LiftsApiFp = function (configuration?: Configuration) { */ async getLiftHealthLiftsLiftNameHealthGet( liftName: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getLiftHealthLiftsLiftNameHealthGet( liftName, @@ -5609,7 +5731,7 @@ export const LiftsApiFp = function (configuration?: Configuration) { */ async getLiftStateLiftsLiftNameStateGet( liftName: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getLiftStateLiftsLiftNameStateGet( liftName, @@ -5624,7 +5746,7 @@ export const LiftsApiFp = function (configuration?: Configuration) { * @throws {RequiredError} */ async getLiftsLiftsGet( - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.getLiftsLiftsGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); @@ -5640,7 +5762,7 @@ export const LiftsApiFp = function (configuration?: Configuration) { async postLiftRequestLiftsLiftNameRequestPost( liftName: string, liftRequest: LiftRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postLiftRequestLiftsLiftNameRequestPost( @@ -5732,7 +5854,7 @@ export class LiftsApi extends BaseAPI { * @throws {RequiredError} * @memberof LiftsApi */ - public getLiftHealthLiftsLiftNameHealthGet(liftName: string, options?: any) { + public getLiftHealthLiftsLiftNameHealthGet(liftName: string, options?: AxiosRequestConfig) { return LiftsApiFp(this.configuration) .getLiftHealthLiftsLiftNameHealthGet(liftName, options) .then((request) => request(this.axios, this.basePath)); @@ -5746,7 +5868,7 @@ export class LiftsApi extends BaseAPI { * @throws {RequiredError} * @memberof LiftsApi */ - public getLiftStateLiftsLiftNameStateGet(liftName: string, options?: any) { + public getLiftStateLiftsLiftNameStateGet(liftName: string, options?: AxiosRequestConfig) { return LiftsApiFp(this.configuration) .getLiftStateLiftsLiftNameStateGet(liftName, options) .then((request) => request(this.axios, this.basePath)); @@ -5759,7 +5881,7 @@ export class LiftsApi extends BaseAPI { * @throws {RequiredError} * @memberof LiftsApi */ - public getLiftsLiftsGet(options?: any) { + public getLiftsLiftsGet(options?: AxiosRequestConfig) { return LiftsApiFp(this.configuration) .getLiftsLiftsGet(options) .then((request) => request(this.axios, this.basePath)); @@ -5777,7 +5899,7 @@ export class LiftsApi extends BaseAPI { public postLiftRequestLiftsLiftNameRequestPost( liftName: string, liftRequest: LiftRequest, - options?: any, + options?: AxiosRequestConfig, ) { return LiftsApiFp(this.configuration) .postLiftRequestLiftsLiftNameRequestPost(liftName, liftRequest, options) @@ -5802,7 +5924,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration getTaskLogTasksTaskIdLogGet: async ( taskId: string, between?: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'taskId' is not null or undefined assertParamExists('getTaskLogTasksTaskIdLogGet', 'taskId', taskId); @@ -5825,7 +5947,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['between'] = between; } - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5847,7 +5969,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ getTaskStateTasksTaskIdStateGet: async ( taskId: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'taskId' is not null or undefined assertParamExists('getTaskStateTasksTaskIdStateGet', 'taskId', taskId); @@ -5866,7 +5988,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration const localVarHeaderParameter = {} as any; const localVarQueryParameter = {} as any; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5888,7 +6010,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ postActivityDiscoveryTasksActivityDiscoveryPost: async ( activityDiscoveryRequest: ActivityDiscoveryRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'activityDiscoveryRequest' is not null or undefined assertParamExists( @@ -5910,7 +6032,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5937,7 +6059,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ postCancelTaskTasksCancelTaskPost: async ( cancelTaskRequest: CancelTaskRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'cancelTaskRequest' is not null or undefined assertParamExists( @@ -5959,7 +6081,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -5977,6 +6099,55 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration options: localVarRequestOptions, }; }, + /** + * + * @summary Post Dispatch Task + * @param {DispatchTaskRequest} dispatchTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postDispatchTaskTasksDispatchTaskPost: async ( + dispatchTaskRequest: DispatchTaskRequest, + options: AxiosRequestConfig = {}, + ): Promise => { + // verify required parameter 'dispatchTaskRequest' is not null or undefined + assertParamExists( + 'postDispatchTaskTasksDispatchTaskPost', + 'dispatchTaskRequest', + dispatchTaskRequest, + ); + const localVarPath = `/tasks/dispatch_task`; + // 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; + + localVarHeaderParameter['Content-Type'] = 'application/json'; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + localVarRequestOptions.data = serializeDataIfNeeded( + dispatchTaskRequest, + localVarRequestOptions, + configuration, + ); + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * * @summary Post Interrupt Task @@ -5986,7 +6157,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ postInterruptTaskTasksInterruptTaskPost: async ( taskInterruptionRequest: TaskInterruptionRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'taskInterruptionRequest' is not null or undefined assertParamExists( @@ -6008,7 +6179,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -6035,7 +6206,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ postKillTaskTasksKillTaskPost: async ( taskKillRequest: TaskKillRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'taskKillRequest' is not null or undefined assertParamExists('postKillTaskTasksKillTaskPost', 'taskKillRequest', taskKillRequest); @@ -6053,7 +6224,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -6080,7 +6251,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ postResumeTaskTasksResumeTaskPost: async ( taskResumeRequest: TaskResumeRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'taskResumeRequest' is not null or undefined assertParamExists( @@ -6102,7 +6273,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -6129,7 +6300,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ postRewindTaskTasksRewindTaskPost: async ( taskRewindRequest: TaskRewindRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'taskRewindRequest' is not null or undefined assertParamExists( @@ -6151,7 +6322,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -6178,7 +6349,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ postSkipPhaseTasksSkipPhasePost: async ( taskPhaseSkipRequest: TaskPhaseSkipRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'taskPhaseSkipRequest' is not null or undefined assertParamExists( @@ -6200,7 +6371,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -6227,7 +6398,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ postTaskDiscoveryTasksTaskDiscoveryPost: async ( taskDiscoveryRequest: TaskDiscoveryRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'taskDiscoveryRequest' is not null or undefined assertParamExists( @@ -6249,7 +6420,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -6267,55 +6438,6 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration options: localVarRequestOptions, }; }, - /** - * - * @summary Post Task Request - * @param {DispatchTaskRequest} dispatchTaskRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - postTaskRequestTasksDispatchTaskPost: async ( - dispatchTaskRequest: DispatchTaskRequest, - options: any = {}, - ): Promise => { - // verify required parameter 'dispatchTaskRequest' is not null or undefined - assertParamExists( - 'postTaskRequestTasksDispatchTaskPost', - 'dispatchTaskRequest', - dispatchTaskRequest, - ); - const localVarPath = `/tasks/dispatch_task`; - // 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; - - localVarHeaderParameter['Content-Type'] = 'application/json'; - - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); - let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; - localVarRequestOptions.headers = { - ...localVarHeaderParameter, - ...headersFromBaseOptions, - ...options.headers, - }; - localVarRequestOptions.data = serializeDataIfNeeded( - dispatchTaskRequest, - localVarRequestOptions, - configuration, - ); - - return { - url: toPathString(localVarUrlObj), - options: localVarRequestOptions, - }; - }, /** * * @summary Post Undo Skip Phase @@ -6325,7 +6447,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration */ postUndoSkipPhaseTasksUndoSkipPhasePost: async ( undoPhaseSkipRequest: UndoPhaseSkipRequest, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { // verify required parameter 'undoPhaseSkipRequest' is not null or undefined assertParamExists( @@ -6347,7 +6469,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarHeaderParameter['Content-Type'] = 'application/json'; - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -6386,7 +6508,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration limit?: number, offset?: number, orderBy?: string, - options: any = {}, + options: AxiosRequestConfig = {}, ): Promise => { const localVarPath = `/tasks`; // use dummy base URL string because the URL constructor only accepts absolute URLs. @@ -6430,7 +6552,7 @@ export const TasksApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['order_by'] = orderBy; } - setSearchParams(localVarUrlObj, localVarQueryParameter, options.query); + setSearchParams(localVarUrlObj, localVarQueryParameter); let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; localVarRequestOptions.headers = { ...localVarHeaderParameter, @@ -6464,7 +6586,7 @@ export const TasksApiFp = function (configuration?: Configuration) { async getTaskLogTasksTaskIdLogGet( taskId: string, between?: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskLogTasksTaskIdLogGet( taskId, @@ -6482,7 +6604,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async getTaskStateTasksTaskIdStateGet( taskId: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.getTaskStateTasksTaskIdStateGet( taskId, @@ -6499,7 +6621,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async postActivityDiscoveryTasksActivityDiscoveryPost( activityDiscoveryRequest: ActivityDiscoveryRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postActivityDiscoveryTasksActivityDiscoveryPost( @@ -6517,7 +6639,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async postCancelTaskTasksCancelTaskPost( cancelTaskRequest: CancelTaskRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postCancelTaskTasksCancelTaskPost( cancelTaskRequest, @@ -6525,6 +6647,26 @@ export const TasksApiFp = function (configuration?: Configuration) { ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * + * @summary Post Dispatch Task + * @param {DispatchTaskRequest} dispatchTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async postDispatchTaskTasksDispatchTaskPost( + dispatchTaskRequest: DispatchTaskRequest, + options?: AxiosRequestConfig, + ): Promise< + (axios?: AxiosInstance, basePath?: string) => AxiosPromise + > { + const localVarAxiosArgs = + await localVarAxiosParamCreator.postDispatchTaskTasksDispatchTaskPost( + dispatchTaskRequest, + options, + ); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * * @summary Post Interrupt Task @@ -6534,7 +6676,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async postInterruptTaskTasksInterruptTaskPost( taskInterruptionRequest: TaskInterruptionRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise< (axios?: AxiosInstance, basePath?: string) => AxiosPromise > { @@ -6554,7 +6696,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async postKillTaskTasksKillTaskPost( taskKillRequest: TaskKillRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postKillTaskTasksKillTaskPost( taskKillRequest, @@ -6571,7 +6713,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async postResumeTaskTasksResumeTaskPost( taskResumeRequest: TaskResumeRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postResumeTaskTasksResumeTaskPost( taskResumeRequest, @@ -6588,7 +6730,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async postRewindTaskTasksRewindTaskPost( taskRewindRequest: TaskRewindRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postRewindTaskTasksRewindTaskPost( taskRewindRequest, @@ -6605,7 +6747,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async postSkipPhaseTasksSkipPhasePost( taskPhaseSkipRequest: TaskPhaseSkipRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postSkipPhaseTasksSkipPhasePost( taskPhaseSkipRequest, @@ -6622,7 +6764,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async postTaskDiscoveryTasksTaskDiscoveryPost( taskDiscoveryRequest: TaskDiscoveryRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postTaskDiscoveryTasksTaskDiscoveryPost( @@ -6631,24 +6773,6 @@ export const TasksApiFp = function (configuration?: Configuration) { ); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, - /** - * - * @summary Post Task Request - * @param {DispatchTaskRequest} dispatchTaskRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - async postTaskRequestTasksDispatchTaskPost( - dispatchTaskRequest: DispatchTaskRequest, - options?: any, - ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = - await localVarAxiosParamCreator.postTaskRequestTasksDispatchTaskPost( - dispatchTaskRequest, - options, - ); - return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); - }, /** * * @summary Post Undo Skip Phase @@ -6658,7 +6782,7 @@ export const TasksApiFp = function (configuration?: Configuration) { */ async postUndoSkipPhaseTasksUndoSkipPhasePost( undoPhaseSkipRequest: UndoPhaseSkipRequest, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { const localVarAxiosArgs = await localVarAxiosParamCreator.postUndoSkipPhaseTasksUndoSkipPhasePost( @@ -6688,7 +6812,7 @@ export const TasksApiFp = function (configuration?: Configuration) { limit?: number, offset?: number, orderBy?: string, - options?: any, + options?: AxiosRequestConfig, ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { const localVarAxiosArgs = await localVarAxiosParamCreator.queryTaskStatesTasksGet( taskId, @@ -6775,6 +6899,21 @@ export const TasksApiFactory = function ( .postCancelTaskTasksCancelTaskPost(cancelTaskRequest, options) .then((request) => request(axios, basePath)); }, + /** + * + * @summary Post Dispatch Task + * @param {DispatchTaskRequest} dispatchTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + postDispatchTaskTasksDispatchTaskPost( + dispatchTaskRequest: DispatchTaskRequest, + options?: any, + ): AxiosPromise { + return localVarFp + .postDispatchTaskTasksDispatchTaskPost(dispatchTaskRequest, options) + .then((request) => request(axios, basePath)); + }, /** * * @summary Post Interrupt Task @@ -6865,21 +7004,6 @@ export const TasksApiFactory = function ( .postTaskDiscoveryTasksTaskDiscoveryPost(taskDiscoveryRequest, options) .then((request) => request(axios, basePath)); }, - /** - * - * @summary Post Task Request - * @param {DispatchTaskRequest} dispatchTaskRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - */ - postTaskRequestTasksDispatchTaskPost( - dispatchTaskRequest: DispatchTaskRequest, - options?: any, - ): AxiosPromise { - return localVarFp - .postTaskRequestTasksDispatchTaskPost(dispatchTaskRequest, options) - .then((request) => request(axios, basePath)); - }, /** * * @summary Post Undo Skip Phase @@ -6950,7 +7074,11 @@ export class TasksApi extends BaseAPI { * @throws {RequiredError} * @memberof TasksApi */ - public getTaskLogTasksTaskIdLogGet(taskId: string, between?: string, options?: any) { + public getTaskLogTasksTaskIdLogGet( + taskId: string, + between?: string, + options?: AxiosRequestConfig, + ) { return TasksApiFp(this.configuration) .getTaskLogTasksTaskIdLogGet(taskId, between, options) .then((request) => request(this.axios, this.basePath)); @@ -6964,7 +7092,7 @@ export class TasksApi extends BaseAPI { * @throws {RequiredError} * @memberof TasksApi */ - public getTaskStateTasksTaskIdStateGet(taskId: string, options?: any) { + public getTaskStateTasksTaskIdStateGet(taskId: string, options?: AxiosRequestConfig) { return TasksApiFp(this.configuration) .getTaskStateTasksTaskIdStateGet(taskId, options) .then((request) => request(this.axios, this.basePath)); @@ -6980,7 +7108,7 @@ export class TasksApi extends BaseAPI { */ public postActivityDiscoveryTasksActivityDiscoveryPost( activityDiscoveryRequest: ActivityDiscoveryRequest, - options?: any, + options?: AxiosRequestConfig, ) { return TasksApiFp(this.configuration) .postActivityDiscoveryTasksActivityDiscoveryPost(activityDiscoveryRequest, options) @@ -6995,12 +7123,32 @@ export class TasksApi extends BaseAPI { * @throws {RequiredError} * @memberof TasksApi */ - public postCancelTaskTasksCancelTaskPost(cancelTaskRequest: CancelTaskRequest, options?: any) { + public postCancelTaskTasksCancelTaskPost( + cancelTaskRequest: CancelTaskRequest, + options?: AxiosRequestConfig, + ) { return TasksApiFp(this.configuration) .postCancelTaskTasksCancelTaskPost(cancelTaskRequest, options) .then((request) => request(this.axios, this.basePath)); } + /** + * + * @summary Post Dispatch Task + * @param {DispatchTaskRequest} dispatchTaskRequest + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof TasksApi + */ + public postDispatchTaskTasksDispatchTaskPost( + dispatchTaskRequest: DispatchTaskRequest, + options?: AxiosRequestConfig, + ) { + return TasksApiFp(this.configuration) + .postDispatchTaskTasksDispatchTaskPost(dispatchTaskRequest, options) + .then((request) => request(this.axios, this.basePath)); + } + /** * * @summary Post Interrupt Task @@ -7011,7 +7159,7 @@ export class TasksApi extends BaseAPI { */ public postInterruptTaskTasksInterruptTaskPost( taskInterruptionRequest: TaskInterruptionRequest, - options?: any, + options?: AxiosRequestConfig, ) { return TasksApiFp(this.configuration) .postInterruptTaskTasksInterruptTaskPost(taskInterruptionRequest, options) @@ -7026,7 +7174,10 @@ export class TasksApi extends BaseAPI { * @throws {RequiredError} * @memberof TasksApi */ - public postKillTaskTasksKillTaskPost(taskKillRequest: TaskKillRequest, options?: any) { + public postKillTaskTasksKillTaskPost( + taskKillRequest: TaskKillRequest, + options?: AxiosRequestConfig, + ) { return TasksApiFp(this.configuration) .postKillTaskTasksKillTaskPost(taskKillRequest, options) .then((request) => request(this.axios, this.basePath)); @@ -7040,7 +7191,10 @@ export class TasksApi extends BaseAPI { * @throws {RequiredError} * @memberof TasksApi */ - public postResumeTaskTasksResumeTaskPost(taskResumeRequest: TaskResumeRequest, options?: any) { + public postResumeTaskTasksResumeTaskPost( + taskResumeRequest: TaskResumeRequest, + options?: AxiosRequestConfig, + ) { return TasksApiFp(this.configuration) .postResumeTaskTasksResumeTaskPost(taskResumeRequest, options) .then((request) => request(this.axios, this.basePath)); @@ -7054,7 +7208,10 @@ export class TasksApi extends BaseAPI { * @throws {RequiredError} * @memberof TasksApi */ - public postRewindTaskTasksRewindTaskPost(taskRewindRequest: TaskRewindRequest, options?: any) { + public postRewindTaskTasksRewindTaskPost( + taskRewindRequest: TaskRewindRequest, + options?: AxiosRequestConfig, + ) { return TasksApiFp(this.configuration) .postRewindTaskTasksRewindTaskPost(taskRewindRequest, options) .then((request) => request(this.axios, this.basePath)); @@ -7070,7 +7227,7 @@ export class TasksApi extends BaseAPI { */ public postSkipPhaseTasksSkipPhasePost( taskPhaseSkipRequest: TaskPhaseSkipRequest, - options?: any, + options?: AxiosRequestConfig, ) { return TasksApiFp(this.configuration) .postSkipPhaseTasksSkipPhasePost(taskPhaseSkipRequest, options) @@ -7087,30 +7244,13 @@ export class TasksApi extends BaseAPI { */ public postTaskDiscoveryTasksTaskDiscoveryPost( taskDiscoveryRequest: TaskDiscoveryRequest, - options?: any, + options?: AxiosRequestConfig, ) { return TasksApiFp(this.configuration) .postTaskDiscoveryTasksTaskDiscoveryPost(taskDiscoveryRequest, options) .then((request) => request(this.axios, this.basePath)); } - /** - * - * @summary Post Task Request - * @param {DispatchTaskRequest} dispatchTaskRequest - * @param {*} [options] Override http request option. - * @throws {RequiredError} - * @memberof TasksApi - */ - public postTaskRequestTasksDispatchTaskPost( - dispatchTaskRequest: DispatchTaskRequest, - options?: any, - ) { - return TasksApiFp(this.configuration) - .postTaskRequestTasksDispatchTaskPost(dispatchTaskRequest, options) - .then((request) => request(this.axios, this.basePath)); - } - /** * * @summary Post Undo Skip Phase @@ -7121,7 +7261,7 @@ export class TasksApi extends BaseAPI { */ public postUndoSkipPhaseTasksUndoSkipPhasePost( undoPhaseSkipRequest: UndoPhaseSkipRequest, - options?: any, + options?: AxiosRequestConfig, ) { return TasksApiFp(this.configuration) .postUndoSkipPhaseTasksUndoSkipPhasePost(undoPhaseSkipRequest, options) @@ -7150,7 +7290,7 @@ export class TasksApi extends BaseAPI { limit?: number, offset?: number, orderBy?: string, - options?: any, + options?: AxiosRequestConfig, ) { return TasksApiFp(this.configuration) .queryTaskStatesTasksGet( diff --git a/packages/api-client/lib/openapi/base.ts b/packages/api-client/lib/openapi/base.ts index 488111854..d68780e5d 100644 --- a/packages/api-client/lib/openapi/base.ts +++ b/packages/api-client/lib/openapi/base.ts @@ -15,7 +15,7 @@ import { Configuration } from './configuration'; // Some imports not used depending on template conditions // @ts-ignore -import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; +import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios'; export const BASE_PATH = 'http://localhost'.replace(/\/+$/, ''); @@ -37,7 +37,7 @@ export const COLLECTION_FORMATS = { */ export interface RequestArgs { url: string; - options: any; + options: AxiosRequestConfig; } /** diff --git a/packages/api-client/lib/openapi/common.ts b/packages/api-client/lib/openapi/common.ts index 7faa79043..ed0261c9f 100644 --- a/packages/api-client/lib/openapi/common.ts +++ b/packages/api-client/lib/openapi/common.ts @@ -14,7 +14,7 @@ import { Configuration } from './configuration'; import { RequiredError, RequestArgs } from './base'; -import { AxiosInstance } from 'axios'; +import { AxiosInstance, AxiosResponse } from 'axios'; /** * @@ -157,11 +157,14 @@ export const createRequestFunction = function ( BASE_PATH: string, configuration?: Configuration, ) { - return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { + return >( + axios: AxiosInstance = globalAxios, + basePath: string = BASE_PATH, + ) => { const axiosRequestArgs = { ...axiosArgs.options, url: (configuration?.basePath || basePath) + axiosArgs.url, }; - return axios.request(axiosRequestArgs); + return axios.request(axiosRequestArgs); }; }; diff --git a/packages/api-client/lib/openapi/git_push.sh b/packages/api-client/lib/openapi/git_push.sh index ced3be2b0..f53a75d4f 100644 --- a/packages/api-client/lib/openapi/git_push.sh +++ b/packages/api-client/lib/openapi/git_push.sh @@ -1,7 +1,7 @@ #!/bin/sh # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ # -# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com" +# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com" git_user_id=$1 git_repo_id=$2 @@ -38,14 +38,14 @@ git add . git commit -m "$release_note" # Sets the new remote -git_remote=`git remote` +git_remote=$(git remote) if [ "$git_remote" = "" ]; then # git remote not defined if [ "$GIT_TOKEN" = "" ]; then echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git else - git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git + git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git fi fi @@ -55,4 +55,3 @@ git pull origin master # Pushes (Forces) the changes in the local repository up to the remote repository echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" git push origin master 2>&1 | grep -v 'To https' - diff --git a/packages/api-client/lib/version.ts b/packages/api-client/lib/version.ts index 619db289c..b9f220fa5 100644 --- a/packages/api-client/lib/version.ts +++ b/packages/api-client/lib/version.ts @@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models'; export const version = { rmfModels: rmfModelVer, - rmfServer: '4e3f02ef452d1360da2f861a9ce947069694aaec', - openapiGenerator: '5.2.1', + rmfServer: '9d79b930b33d80e071c3db1f11d3dcd3ed0f81ce', + openapiGenerator: '5.4.0', }; From f68c7041b5033e3bfa1412c540b9849c6729ef88 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 16 Feb 2022 12:33:27 +0800 Subject: [PATCH 56/79] fix wrong payload for cancel task request Signed-off-by: Teo Koon Peng --- packages/dashboard/src/components/tasks/task-page.tsx | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/packages/dashboard/src/components/tasks/task-page.tsx b/packages/dashboard/src/components/tasks/task-page.tsx index 48c41b746..b201ee405 100644 --- a/packages/dashboard/src/components/tasks/task-page.tsx +++ b/packages/dashboard/src/components/tasks/task-page.tsx @@ -83,7 +83,7 @@ export function TaskPage() { } await Promise.all( taskRequests.map((taskReq) => - tasksApi.postTaskRequestTasksDispatchTaskPost({ + tasksApi.postDispatchTaskTasksDispatchTaskPost({ type: 'dispatch_task_request', request: taskReq, }), @@ -97,7 +97,10 @@ export function TaskPage() { const cancelTask = React.useCallback['cancelTask']>( async (task) => { try { - await tasksApi?.postCancelTaskTasksCancelTaskPost({ type: '', task_id: task.booking.id }); + await tasksApi?.postCancelTaskTasksCancelTaskPost({ + type: 'cancel_task_request', + task_id: task.booking.id, + }); } catch (e) { const axiosErr = e as AxiosError; let errMsg = 'unspecified error'; From 9d51b77d043fefd20b65d090c7b28db4f6682a03 Mon Sep 17 00:00:00 2001 From: Charayaphan Nakorn Boon Han Date: Wed, 16 Feb 2022 15:03:06 +0800 Subject: [PATCH 57/79] Prototype/tasks v2 2 merge prune robot panel (#581) * Prune robot panel and fix data fields Signed-off-by: Charayaphan Nakorn Boon Han * move fetch calls out of react-components Signed-off-by: Charayaphan Nakorn Boon Han * fix unit tests temporarily by adding minimal Signed-off-by: Charayaphan Nakorn Boon Han * remove lint error Signed-off-by: Charayaphan Nakorn Boon Han * filter out null function Signed-off-by: Charayaphan Nakorn Boon Han * revert multi sub to compile Signed-off-by: Mohamad * bypass validation with Optional type Signed-off-by: Charayaphan Nakorn Boon Han * Fix api change for Status Signed-off-by: Charayaphan Nakorn Boon Han * fix infinite refresh Signed-off-by: Charayaphan Nakorn Boon Han * revert multiple subscriptions fix, clean up api breaks Signed-off-by: Charayaphan Nakorn Boon Han * fix tests Signed-off-by: Charayaphan Nakorn Boon Han Co-authored-by: Michael X. Grey Co-authored-by: Mohamad --- packages/api-client/examples/listen.ts | 13 +- packages/api-client/lib/version.ts | 2 +- .../src/components/robots/robot-page.tsx | 51 +++--- .../src/components/tasks/task-panel.tsx | 65 ++++---- .../src/components/tasks/tests/make-tasks.ts | 18 +-- .../tasks/tests/task-panel.test.tsx | 26 ++- .../src/util/common-subscriptions.ts | 2 +- .../lib/robots/robot-info.spec.tsx | 12 +- .../lib/robots/robot-info.tsx | 149 +++--------------- .../lib/robots/robot-panel.spec.tsx | 24 +-- .../lib/robots/robot-panel.tsx | 22 +-- .../lib/robots/robot-table.tsx | 86 +++------- packages/react-components/lib/robots/utils.ts | 10 +- .../lib/tasks/create-task.spec.tsx | 2 +- .../lib/tasks/create-task.tsx | 1 + .../lib/tasks/task-logs.spec.tsx | 26 +-- .../react-components/lib/tasks/task-logs.tsx | 2 +- packages/react-components/lib/tasks/utils.ts | 2 +- 18 files changed, 196 insertions(+), 317 deletions(-) diff --git a/packages/api-client/examples/listen.ts b/packages/api-client/examples/listen.ts index 6039f96c5..c84a945e9 100644 --- a/packages/api-client/examples/listen.ts +++ b/packages/api-client/examples/listen.ts @@ -1,7 +1,8 @@ -import { io } from '../lib'; +import { SioClient } from '../lib'; -const client = io('http://localhost:8000'); -client.emit('subscribe', 'building_map'); -client.emit('subscribe', 'door_states'); -client.on('building_map', () => console.log('got building map')); -client.on('door_states', console.log); +const client = new SioClient('http://localhost:8000'); +const l1 = client.subscribeDoorState('coe_door', console.log); +const l2 = client.subscribeDoorState('coe_door', console.log); + +client.unsubscribe(l1); +client.unsubscribe(l2); diff --git a/packages/api-client/lib/version.ts b/packages/api-client/lib/version.ts index b9f220fa5..ef81d1070 100644 --- a/packages/api-client/lib/version.ts +++ b/packages/api-client/lib/version.ts @@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models'; export const version = { rmfModels: rmfModelVer, - rmfServer: '9d79b930b33d80e071c3db1f11d3dcd3ed0f81ce', + rmfServer: '74c154d735aea685a59c3e82bbdcdfff273a96db', openapiGenerator: '5.4.0', }; diff --git a/packages/dashboard/src/components/robots/robot-page.tsx b/packages/dashboard/src/components/robots/robot-page.tsx index bd1d0ac30..a30c69b47 100644 --- a/packages/dashboard/src/components/robots/robot-page.tsx +++ b/packages/dashboard/src/components/robots/robot-page.tsx @@ -1,7 +1,7 @@ /* istanbul ignore file */ import { styled, GridProps, Grid, Card } from '@mui/material'; import React from 'react'; -import { FleetState, RobotState } from 'api-client'; +import { FleetState } from 'api-client'; import { MapProps, Map } from 'react-leaflet'; import { RobotPanel, VerboseRobot } from 'react-components'; import { @@ -69,37 +69,50 @@ export function RobotPage() { // robot panel stuff const [hasMore, setHasMore] = React.useState(true); const [page, setPage] = React.useState(0); - const [verboseRobots, setVerboseRobots] = React.useState([]); + const [verboseRobots, setVerboseRobots] = React.useState([]); + + const fetchSelectedTask = React.useCallback( + async (taskId: string) => { + if (!taskApi) return; + const resp = await taskApi.getTaskStateTasksTaskIdStateGet(taskId); + return resp.data; + }, + [taskApi], + ); + const fetchVerboseRobots = React.useCallback(async () => { if (!rmfIngress) { setHasMore(false); return []; } const resp = await rmfIngress.fleetsApi.getFleetsFleetsGet(); - let robotState: RobotState[] = []; + let verboseRobots: VerboseRobot[] = []; resp.data?.forEach((fleet) => { const robotKey = fleet.robots && Object.keys(fleet.robots); - robotKey?.forEach((key) => { - fleet.robots && robotState.push(fleet.robots[key]); + robotKey?.forEach(async (key) => { + if (fleet.robots) { + let robot = fleet.robots[key]; + if (robot.task_id) { + let task = await fetchSelectedTask(robot.task_id); + verboseRobots.push({ state: fleet.robots[key], current_task_state: task }); + } else { + verboseRobots.push({ state: fleet.robots[key] }); + } + } }); }); - setVerboseRobots(robotState); - return resp.data; - }, [rmfIngress]); - const fetchSelectedTask = React.useCallback( - async (taskId: string) => { - if (!taskApi) return; - const resp = await taskApi.getTaskStateTasksTaskIdStateGet(taskId); - return resp.data; - }, - [taskApi], - ); + setVerboseRobots(verboseRobots); + return resp.data; + }, [rmfIngress, fetchSelectedTask]); - const onRobotZoom = (robot: RobotState) => { + const onRobotZoom = (robot: VerboseRobot) => { leafletMap && leafletMap.leafletElement.setView( - [robot.location ? robot.location.y : 0.0, robot.location ? robot.location.x : 0.0], + [ + robot.state.location ? robot.state.location.y : 0.0, + robot.state.location ? robot.state.location.x : 0.0, + ], 5.5, { animate: true, @@ -131,8 +144,6 @@ export function RobotPage() { (undefined); const profile = React.useContext(UserProfileContext); - const { showErrorAlert } = React.useContext(AppControllerContext); + //const { showErrorAlert } = React.useContext(AppControllerContext); const { tasksApi } = React.useContext(RmfIngressContext) || {}; const handleCancelTaskClick = React.useCallback(async () => { @@ -160,35 +159,35 @@ export function TaskPanel({ }, [cancelTask, selectedTask]); // /* istanbul ignore next */ - const tasksFromFile = (): Promise => { - return new Promise((res) => { - const fileInputEl = uploadFileInputRef.current; - if (!fileInputEl) { - return []; - } - let taskFiles: TaskState[]; - const listener = async () => { - try { - if (!fileInputEl.files || fileInputEl.files.length === 0) { - return res([]); - } - try { - taskFiles = parseTasksFile(await fileInputEl.files[0].text()); - } catch (err) { - showErrorAlert((err as Error).message, 5000); - return res([]); - } - // only submit tasks when all tasks are error free - return res(taskFiles); - } finally { - fileInputEl.removeEventListener('input', listener); - fileInputEl.value = ''; - } - }; - fileInputEl.addEventListener('input', listener); - fileInputEl.click(); - }); - }; + //const tasksFromFile = (): Promise => { + //return new Promise((res) => { + //const fileInputEl = uploadFileInputRef.current; + //if (!fileInputEl) { + //return []; + //} + //let taskFiles: TaskState[]; + //const listener = async () => { + //try { + //if (!fileInputEl.files || fileInputEl.files.length === 0) { + //return res([]); + //} + //try { + //taskFiles = parseTasksFile(await fileInputEl.files[0].text()); + //} catch (err) { + //showErrorAlert((err as Error).message, 5000); + //return res([]); + //} + //// only submit tasks when all tasks are error free + //return res(taskFiles); + //} finally { + //fileInputEl.removeEventListener('input', listener); + //fileInputEl.value = ''; + //} + //}; + //fileInputEl.addEventListener('input', listener); + //fileInputEl.click(); + //}); + //}; const fetchLogs = React.useCallback(async () => { if (!tasksApi) { diff --git a/packages/dashboard/src/components/tasks/tests/make-tasks.ts b/packages/dashboard/src/components/tasks/tests/make-tasks.ts index edb455585..6fd006945 100644 --- a/packages/dashboard/src/components/tasks/tests/make-tasks.ts +++ b/packages/dashboard/src/components/tasks/tests/make-tasks.ts @@ -12,16 +12,16 @@ import { TaskEventLog, TaskState, - Phases, - LogEntry, - Tier, - Booking, - Detail, - Status, - Phase, - EventState, + //Phases, + //LogEntry, + //Tier, + //Booking, + //Detail, + //Status, + //Phase, + //EventState, } from 'api-client'; -import react from 'react'; +//import react from 'react'; /** * FIXME: These `makeX` functions are duplicated in `react-components`. * Whats the best way to dedupe this? diff --git a/packages/dashboard/src/components/tasks/tests/task-panel.test.tsx b/packages/dashboard/src/components/tasks/tests/task-panel.test.tsx index 8ad4695b1..0070ee094 100644 --- a/packages/dashboard/src/components/tasks/tests/task-panel.test.tsx +++ b/packages/dashboard/src/components/tasks/tests/task-panel.test.tsx @@ -1,23 +1,35 @@ // import { waitFor } from '@testing-library/react'; // import userEvent from '@testing-library/user-event'; -import React from 'react'; -// import { TaskSummary as RmfTaskSummary, TaskType as RmfTaskType } from 'rmf-models'; +import { TaskPanel } from '../task-panel'; import { render } from '../../tests/test-utils'; -import { TaskPanel, TaskPanelProps } from '../task-panel'; -import { makeTaskState } from './make-tasks'; -// react-leaflet doesn't work well in jsdom. jest.mock('./../../schedule-visualizer', () => () => null); it('renders without crashing', async () => { URL.createObjectURL = jest.fn(); - const taskState = makeTaskState('0'); - const root = render(); + const root = render(); root.unmount(); (URL.createObjectURL as jest.Mock).mockReset(); }); +// import { TaskSummary as RmfTaskSummary, TaskType as RmfTaskType } from 'rmf-models'; +//import { render } from '../../tests/test-utils'; +//import { TaskPanel, TaskPanelProps } from '../task-panel'; +//import { makeTaskState } from './make-tasks'; + +// react-leaflet doesn't work well in jsdom. +//jest.mock('./../../schedule-visualizer', () => () => null); + +//it('renders without crashing', async () => { +//URL.createObjectURL = jest.fn(); +//const taskState = makeTaskState('0'); + +//const root = render(); +//root.unmount(); +//(URL.createObjectURL as jest.Mock).mockReset(); +//}); + export {}; // describe('TaskPanel', () => { diff --git a/packages/dashboard/src/util/common-subscriptions.ts b/packages/dashboard/src/util/common-subscriptions.ts index bdf11f8bb..c79a12eec 100644 --- a/packages/dashboard/src/util/common-subscriptions.ts +++ b/packages/dashboard/src/util/common-subscriptions.ts @@ -55,7 +55,7 @@ export const useIngestorStatesRef = (sioClient: SioClient | undefined, ingestors ), ); return () => { - subs.forEach((s) => sioClient.unsubscribe(s)); + subs.filter(() => null).forEach((s) => sioClient.unsubscribe(s)); }; }, [sioClient, ingestors, ingestorStatesRef]); return ingestorStatesRef; diff --git a/packages/react-components/lib/robots/robot-info.spec.tsx b/packages/react-components/lib/robots/robot-info.spec.tsx index f003c9c51..8fb654aa7 100644 --- a/packages/react-components/lib/robots/robot-info.spec.tsx +++ b/packages/react-components/lib/robots/robot-info.spec.tsx @@ -1,9 +1,9 @@ -import { render } from '@testing-library/react'; -import type { Task } from 'api-client'; -import React from 'react'; -import { TaskType as RmfTaskType } from 'rmf-models'; -import { RobotInfo } from './robot-info'; -import { makeRandomRobot } from './test-utils.spec'; +//import { render } from '@testing-library/react'; +//import type { Task } from 'api-client'; +//import React from 'react'; +//import { TaskType as RmfTaskType } from 'rmf-models'; +//import { RobotInfo } from './robot-info'; +//import { makeRandomRobot } from './test-utils.spec'; // describe('RobotInfo', () => { // it('information renders correctly', () => { diff --git a/packages/react-components/lib/robots/robot-info.tsx b/packages/react-components/lib/robots/robot-info.tsx index f61d5ee45..7d84c8366 100644 --- a/packages/react-components/lib/robots/robot-info.tsx +++ b/packages/react-components/lib/robots/robot-info.tsx @@ -1,10 +1,10 @@ import { Button, Divider, Grid, Typography, useTheme, styled } from '@mui/material'; -import type { RobotState, TaskState } from 'api-client'; import React from 'react'; -import { taskStateToStr, parseTaskDetail } from '../tasks/utils'; +import { taskStateToStr } from '../tasks/utils'; import { format } from 'date-fns'; import { CircularProgressBar } from './circular-progress-bar'; import { LinearProgressBar } from './linear-progress-bar'; +import { VerboseRobot } from './utils'; const classes = { button: 'robot-info-button', @@ -19,90 +19,19 @@ const StyledDiv = styled('div')(() => ({ })); export interface RobotInfoProps { - robot: RobotState; - fetchSelectedTask?: (taskId: string) => Promise; + robot: VerboseRobot; } -export function RobotInfo({ robot, fetchSelectedTask }: RobotInfoProps): JSX.Element { +export function RobotInfo({ robot }: RobotInfoProps): JSX.Element { const theme = useTheme(); - const [currentTask, setCurrentTask] = React.useState(); - const [hasConcreteEndTime, setHasConcreteEndTime] = React.useState(false); + const [hasConcreteEndTime] = React.useState(false); - React.useEffect(() => { - (async () => { - if (robot.task_id) { - fetchSelectedTask && setCurrentTask(await fetchSelectedTask(robot.task_id)); - } - })(); - }); - - // function returnTaskLocations(task: TaskSummary): string { - // switch (taskTypeToStr(task.task_profile.description.task_type.type)) { - // case 'Loop': - // return task.task_profile.description.loop.start_name; - // case 'Delivery': - // return task.task_profile.description.delivery.pickup_place_name; - // default: - // return '-'; - // } - // } - - // function returnTaskDestinations(task: TaskSummary): string { - // switch (taskTypeToStr(task.task_profile.description.task_type.type)) { - // case 'Loop': - // return task.task_profile.description.loop.finish_name; - // case 'Delivery': - // return task.task_profile.description.delivery.dropoff_place_name; - // case 'Clean': - // return task.task_profile.description.clean.start_waypoint; - // default: - // return '-'; - // } - // } - - // function assignedTasksToStr(robot: RobotState): string { - // return robot.tasks - // .map((task, index) => { - // if (index !== robot.tasks.length - 1) { - // return task.booking.id.concat(' → '); - // } else { - // return task.booking.id; - // } - // }) - // .join(''); - // } - - // React.useEffect(() => { - // const concreteTasks = [ - // RmfTaskSummary.STATE_CANCELED, - // RmfTaskSummary.STATE_COMPLETED, - // RmfTaskSummary.STATE_FAILED, - // ]; - - // if (robot.tasks.length > 0) { - // setCurrentTask(robot.tasks[0]); - // if (currentTask) { - // setHasConcreteEndTime(concreteTasks.includes(currentTask.summary.state)); - // } - // } else { - // setCurrentTask(undefined); - // setHasConcreteEndTime(false); - // } - // }, [currentTask, robot, setCurrentTask]); - - const taskDetails = React.useMemo(() => { - // if (currentTask) { - // const location = returnTaskLocations(currentTask.summary); - // const destination = returnTaskDestinations(currentTask.summary); - // const assignedTasks = assignedTasksToStr(robot); - // return { location, destination, assignedTasks }; - // } - }, [currentTask, robot]); + const currentTask = robot.current_task_state; return ( - {robot.name} + {robot.state.name}
@@ -113,14 +42,18 @@ export function RobotInfo({ robot, fetchSelectedTask }: RobotInfoProps): JSX.Ele - 11% - {/**TODO - figure out a way to calculate task progress - * One idea is to use the length of pending and completed phases - * drawback is that there may be some task without any phases so a seperate solution needs to handle such a case - */} - {/* {currentTask && ( - - )} */} + {currentTask && + currentTask.unix_millis_start_time && + currentTask.unix_millis_finish_time ? ( + + ) : ( + + )} @@ -136,41 +69,7 @@ export function RobotInfo({ robot, fetchSelectedTask }: RobotInfoProps): JSX.Ele component="div" > assigned task - {robot ? ` - ${robot.task_id}` : '-'} - - - - - Location - - - - - Destination - - - - - - - @@ -185,10 +84,12 @@ export function RobotInfo({ robot, fetchSelectedTask }: RobotInfoProps): JSX.Ele - {`${robot.battery ? robot.battery * 100 : 0}%`} + {`${ + robot.state.battery ? robot.state.battery * 100 : 0 + }%`} @@ -202,7 +103,7 @@ export function RobotInfo({ robot, fetchSelectedTask }: RobotInfoProps): JSX.Ele time {currentTask?.estimate_millis ? ` - ${format( - new Date(currentTask.estimate_millis * 1000 + Date.now()), + new Date(currentTask.estimate_millis * 1 + Date.now()), "hh:mm aaaaa'm'", )}` : '-'} diff --git a/packages/react-components/lib/robots/robot-panel.spec.tsx b/packages/react-components/lib/robots/robot-panel.spec.tsx index 5b576162c..7d482ad20 100644 --- a/packages/react-components/lib/robots/robot-panel.spec.tsx +++ b/packages/react-components/lib/robots/robot-panel.spec.tsx @@ -1,16 +1,18 @@ -import { render } from '@testing-library/react'; -import userEvent from '@testing-library/user-event'; -import React from 'react'; +//import { render } from '@testing-library/react'; +//import userEvent from '@testing-library/user-event'; +//import React from 'react'; // import { makeDefinedTask } from '../tasks/test-data.spec'; -import { RobotPanel, RobotPanelProps } from './robot-panel'; -import { makeRandomRobot } from './test-utils.spec'; -import { VerboseRobot } from './utils'; +//import { RobotPanel, RobotPanelProps } from './robot-panel'; +//import { makeRandomRobot } from './test-utils.spec'; +//import { VerboseRobot } from './utils'; -function makeFetchRobots(robots: VerboseRobot[]): RobotPanelProps['fetchVerboseRobots'] { - return async () => { - return robots; - }; -} +//function makeFetchRobots(robots: VerboseRobot[]): RobotPanelProps['fetchVerboseRobots'] { +//return async () => { +//return robots; +//}; +//} + +// TODO(FIXME): Fix tests for Tasksv2 // describe('RobotPanel', () => { // it('shows empty information when robot is clicked when there are no assigned tasks', async () => { diff --git a/packages/react-components/lib/robots/robot-panel.tsx b/packages/react-components/lib/robots/robot-panel.tsx index 7f8e8c169..0aacb900c 100644 --- a/packages/react-components/lib/robots/robot-panel.tsx +++ b/packages/react-components/lib/robots/robot-panel.tsx @@ -1,5 +1,4 @@ import { Grid, Paper, TablePagination, Typography, styled } from '@mui/material'; -import { RobotState, TaskState } from 'api-client'; import React from 'react'; import { RobotInfo } from './robot-info'; import { RobotTable } from './robot-table'; @@ -36,9 +35,7 @@ function NoSelectedRobot() { export interface RobotPanelProps extends React.DetailedHTMLProps, HTMLDivElement> { paginationOptions?: Omit, 'component'>; - verboseRobots: RobotState[]; - fetchVerboseRobots: () => Promise; - fetchSelectedTask?: (taskId: string) => Promise; + verboseRobots: VerboseRobot[]; onRobotZoom?: (robot: VerboseRobot) => void; } @@ -47,18 +44,15 @@ export interface RobotPanelProps export function RobotPanel({ paginationOptions, verboseRobots, - fetchVerboseRobots, - fetchSelectedTask, onRobotZoom, ...divProps }: RobotPanelProps): JSX.Element { - const [selectedRobot, setSelectedRobot] = React.useState(undefined); + const [selectedRobot, setSelectedRobot] = React.useState(undefined); - const handleRefresh = async (selectedRobot?: RobotState) => { + const handleRefresh = async (selectedRobot?: VerboseRobot) => { (async () => { - const result = await fetchVerboseRobots(); - result.forEach((robot) => { - if (selectedRobot && robot.name === selectedRobot.name) { + verboseRobots.forEach((robot) => { + if (selectedRobot && robot.state.name === selectedRobot.state.name) { setSelectedRobot(robot); } }); @@ -87,11 +81,7 @@ export function RobotPanel({ /> - {selectedRobot ? ( - - ) : ( - - )} + {selectedRobot ? : } diff --git a/packages/react-components/lib/robots/robot-table.tsx b/packages/react-components/lib/robots/robot-table.tsx index 5da684353..3b688db52 100644 --- a/packages/react-components/lib/robots/robot-table.tsx +++ b/packages/react-components/lib/robots/robot-table.tsx @@ -13,9 +13,10 @@ import { Typography, styled, } from '@mui/material'; -import type { RobotState } from 'api-client'; +import type { TaskState } from 'api-client'; import { Refresh as RefreshIcon } from '@mui/icons-material'; import React from 'react'; +import { VerboseRobot } from '.'; const classes = { table: 'robot-table', @@ -59,45 +60,11 @@ const StyledPaper = styled((props: PaperProps) => )(({ theme })); interface RobotRowProps { - robot: RobotState; + verboseRobot: VerboseRobot; onClick: React.MouseEventHandler; } -const returnLocationCells = (robot: RobotState) => { - // const taskDescription = robot.tasks[0].summary.task_profile.description; - // switch (taskTypeToStr(taskDescription.task_type.type)) { - // case 'Loop': - // return ( - // <> - // {taskDescription.loop.start_name} - // {taskDescription.loop.finish_name} - // - // ); - // case 'Delivery': - // return ( - // <> - // {taskDescription.delivery.pickup_place_name} - // {taskDescription.delivery.dropoff_place_name} - // - // ); - // case 'Clean': - // return ( - // <> - // - - // {taskDescription.clean.start_waypoint} - // - // ); - // default: - return ( - <> - - - - - - ); - // } -}; - -function RobotRow({ robot, onClick }: RobotRowProps) { +function RobotRow({ verboseRobot, onClick }: RobotRowProps) { const getRobotModeClass = (robotMode: string) => { switch (robotMode) { case 'emergency': @@ -114,19 +81,23 @@ function RobotRow({ robot, onClick }: RobotRowProps) { return ''; } }; - let robotModeClass = ''; - if (robot.status) robotModeClass = getRobotModeClass(robot.status); + const st = verboseRobot.state.status ? verboseRobot.state.status : ''; + const robotModeClass = getRobotModeClass(st); + const name = verboseRobot.state.name; + const battery = verboseRobot.state.battery ? verboseRobot.state.battery * 100 : 0; + + if (verboseRobot.current_task_state) { + const date = verboseRobot.current_task_state.estimate_millis + ? new Date(verboseRobot.current_task_state.estimate_millis).toISOString().substr(11, 8) + : '-'; - if (robot.task_id) { return ( <> - {robot.name} - {'-'} - {'-'} - {'-'} - {robot.battery ? robot.battery * 100 : 0}% - {robot.status} + {name} + {date} + {battery}% + {st} ); @@ -134,16 +105,10 @@ function RobotRow({ robot, onClick }: RobotRowProps) { return ( <> - {robot.name} - {returnLocationCells(robot)} - - end time - {/* {robot.tasks - ? robot.tasks[0].summary.end_time.sec - robot.tasks[0].summary.start_time.sec - : '-'} */} - - {robot.battery ? robot.battery * 100 : 0}% - {robot.status} + {name} + {'-'} + {battery}% + {st} ); @@ -160,10 +125,11 @@ export interface RobotTableProps extends PaperProps { * The current list of robots to display, when pagination is enabled, this should only * contain the robots for the current page. */ - robots: RobotState[]; + robots: VerboseRobot[]; + fetchSelectedTask?: (taskId: string) => Promise; paginationOptions?: PaginationOptions; onRefreshClick?: React.MouseEventHandler; - onRobotClick?(ev: React.MouseEvent, robot: RobotState): void; + onRobotClick?(ev: React.MouseEvent, robot: VerboseRobot): void; } export function RobotTable({ @@ -188,8 +154,6 @@ export function RobotTable({ Robot Name - Start Location - Destination Active Task Duration Battery State @@ -200,7 +164,7 @@ export function RobotTable({ robots.map((robot, robot_id) => ( onRobotClick && onRobotClick(ev, robot)} /> ))} diff --git a/packages/react-components/lib/robots/utils.ts b/packages/react-components/lib/robots/utils.ts index d0d31f578..fd5b39472 100644 --- a/packages/react-components/lib/robots/utils.ts +++ b/packages/react-components/lib/robots/utils.ts @@ -1,5 +1,5 @@ -import type { TaskState } from 'api-client'; -import { RobotMode as RmfRobotMode, RobotState as RmfRobotState } from 'rmf-models'; +import { RobotMode as RmfRobotMode } from 'rmf-models'; +import type { RobotState, TaskState } from 'api-client'; /** * Returns a uniquely identifiable string representing a robot. @@ -32,8 +32,6 @@ export function robotModeToString(robotMode: RmfRobotMode): string { } export interface VerboseRobot { - fleet: string; - name: string; - state: RmfRobotState; - tasks: TaskState[]; + state: RobotState; + current_task_state?: TaskState; } diff --git a/packages/react-components/lib/tasks/create-task.spec.tsx b/packages/react-components/lib/tasks/create-task.spec.tsx index d961861d0..d90810a59 100644 --- a/packages/react-components/lib/tasks/create-task.spec.tsx +++ b/packages/react-components/lib/tasks/create-task.spec.tsx @@ -1,6 +1,6 @@ // import { render, RenderResult, waitForElementToBeRemoved, within } from '@testing-library/react'; // import userEvent from '@testing-library/user-event'; -import React from 'react'; +//import React from 'react'; // import { TaskType as RmfTaskType } from 'rmf-models'; // import { CreateTaskForm } from './create-task'; diff --git a/packages/react-components/lib/tasks/create-task.tsx b/packages/react-components/lib/tasks/create-task.tsx index 73451f56b..de5def7a4 100644 --- a/packages/react-components/lib/tasks/create-task.tsx +++ b/packages/react-components/lib/tasks/create-task.tsx @@ -504,6 +504,7 @@ export function CreateTaskForm({ setSubmitting(true); try { setSubmitting(true); + console.log(taskRequests); await submitTasks(taskRequests); setSubmitting(false); onSuccess && onSuccess(taskRequests); diff --git a/packages/react-components/lib/tasks/task-logs.spec.tsx b/packages/react-components/lib/tasks/task-logs.spec.tsx index cc335a6ff..3687afa5e 100644 --- a/packages/react-components/lib/tasks/task-logs.spec.tsx +++ b/packages/react-components/lib/tasks/task-logs.spec.tsx @@ -1,18 +1,18 @@ -import { render } from '@testing-library/react'; -import React from 'react'; -import { TaskLogs } from './task-logs'; -import { makeTaskLog } from './test-data.spec'; +//import { render } from '@testing-library/react'; +//import React from 'react'; +//import { TaskLogs } from './task-logs'; +//import { makeTaskLog } from './test-data.spec'; describe('TaskLogs', () => { it('shows all event logs', () => { - const logs = makeTaskLog('task'); - const root = render(); - Object.values(logs.phases).forEach((p) => { - Object.values(p.events).forEach((e) => { - e.forEach((l) => { - expect(root.getAllByText(l.text).length).toBeGreaterThan(0); - }); - }); - }); + //const logs = makeTaskLog('task'); + //const root = render(); + //Object.values(logs.phases).forEach((p) => { + //Object.values(p.events).forEach((e) => { + //e.forEach((l) => { + //expect(root.getAllByText(l.text).length).toBeGreaterThan(0); + //}); + //}); + //}); }); }); diff --git a/packages/react-components/lib/tasks/task-logs.tsx b/packages/react-components/lib/tasks/task-logs.tsx index 4abcada13..b37580b82 100644 --- a/packages/react-components/lib/tasks/task-logs.tsx +++ b/packages/react-components/lib/tasks/task-logs.tsx @@ -1,6 +1,6 @@ import React from 'react'; import { Divider, Grid, Paper, PaperProps, styled, Typography, useTheme } from '@mui/material'; -import { TaskEventLog, TaskState, EventState, Status, LogEntry } from 'api-client'; +import { TaskEventLog, TaskState, EventState, Status } from 'api-client'; import { format } from 'date-fns'; const prefix = 'task-logs'; const classes = { diff --git a/packages/react-components/lib/tasks/utils.ts b/packages/react-components/lib/tasks/utils.ts index a86b41e20..d316031b2 100644 --- a/packages/react-components/lib/tasks/utils.ts +++ b/packages/react-components/lib/tasks/utils.ts @@ -1,4 +1,4 @@ -import { TaskSummary as RmfTaskSummary, TaskType as RmfTaskType } from 'rmf-models'; +import { TaskType as RmfTaskType } from 'rmf-models'; import type { TaskState } from 'api-client'; export function taskStateToStr(taskState: TaskState): string { From 9dec007143fd6aa3491d7a1bf817feca3c1c099b Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 16 Feb 2022 15:10:12 +0800 Subject: [PATCH 58/79] re-enable skipped test Signed-off-by: Teo Koon Peng --- packages/react-components/lib/tasks/task-timeline.spec.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react-components/lib/tasks/task-timeline.spec.tsx b/packages/react-components/lib/tasks/task-timeline.spec.tsx index c96701b95..103907184 100644 --- a/packages/react-components/lib/tasks/task-timeline.spec.tsx +++ b/packages/react-components/lib/tasks/task-timeline.spec.tsx @@ -5,7 +5,7 @@ import { makeTaskState } from './test-data.spec'; describe('Task Timeline', () => { // FIXME: sample phases has no start time - xit('shows the time for each phase', () => { + it('shows the time for each phase', () => { const task = makeTaskState('task_0'); const root = render(); Object.values(task.phases).forEach((p) => { From b06b85c84b0ee2381a83de29f3833d4a4908c278 Mon Sep 17 00:00:00 2001 From: Charayaphan Nakorn Boon Han Date: Wed, 16 Feb 2022 17:32:26 +0800 Subject: [PATCH 59/79] fix task cancellation in dashboard Signed-off-by: Charayaphan Nakorn Boon Han --- packages/dashboard/src/components/tasks/task-panel.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/dashboard/src/components/tasks/task-panel.tsx b/packages/dashboard/src/components/tasks/task-panel.tsx index 998114dd8..c750603b7 100644 --- a/packages/dashboard/src/components/tasks/task-panel.tsx +++ b/packages/dashboard/src/components/tasks/task-panel.tsx @@ -146,7 +146,7 @@ export function TaskPanel({ return; } try { - // await cancelTask(selectedTask.summary); + await cancelTask(selectedTask); setSnackbarMessage('Successfully cancelled task'); setSnackbarSeverity('success'); setOpenSnackbar(true); From ed6995df96d99d66608dfe99936a7b6589a9b933 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 16 Feb 2022 18:24:33 +0800 Subject: [PATCH 60/79] refactored robot components, wip fixing locales Signed-off-by: Teo Koon Peng --- .../lib/date-time-picker.spec.tsx | 37 ------ .../react-components/lib/date-time-picker.tsx | 18 --- packages/react-components/lib/index.ts | 2 +- packages/react-components/lib/locale.tsx | 34 +++++ .../lib/reports/default-date-form.spec.tsx | 21 ++-- .../lib/reports/default-dates-form.tsx | 29 +++-- .../log-management/search-log-form.tsx | 17 ++- packages/react-components/lib/robots/index.ts | 1 - .../lib/robots/robot-info.spec.tsx | 54 ++++---- .../lib/robots/robot-info.stories.tsx | 35 ++---- .../lib/robots/robot-info.tsx | 76 ++++++----- .../lib/robots/robot-panel.spec.tsx | 43 ------- .../lib/robots/robot-panel.stories.tsx | 57 --------- .../lib/robots/robot-panel.tsx | 89 ------------- .../lib/robots/robot-table.spec.tsx | 45 +++---- .../lib/robots/robot-table.stories.tsx | 48 +++---- .../lib/robots/robot-table.tsx | 119 ++++++++---------- .../lib/robots/test-utils.spec.ts | 69 ++-------- packages/react-components/lib/robots/utils.ts | 6 - packages/react-components/lib/tasks/utils.ts | 10 -- 20 files changed, 234 insertions(+), 576 deletions(-) delete mode 100644 packages/react-components/lib/date-time-picker.spec.tsx delete mode 100644 packages/react-components/lib/date-time-picker.tsx create mode 100644 packages/react-components/lib/locale.tsx delete mode 100644 packages/react-components/lib/robots/robot-panel.spec.tsx delete mode 100644 packages/react-components/lib/robots/robot-panel.stories.tsx delete mode 100644 packages/react-components/lib/robots/robot-panel.tsx diff --git a/packages/react-components/lib/date-time-picker.spec.tsx b/packages/react-components/lib/date-time-picker.spec.tsx deleted file mode 100644 index e2afa7b12..000000000 --- a/packages/react-components/lib/date-time-picker.spec.tsx +++ /dev/null @@ -1,37 +0,0 @@ -import { render } from '@testing-library/react'; -import { format } from 'date-fns'; -import React from 'react'; -import { TextField } from '@mui/material'; -import DateAndTimePickers from './date-time-picker'; - -describe('date time picker', () => { - it('shows the correct Label', async () => { - const handleDateChange = jasmine.createSpy(); - const timestamp = new Date('Mon Jan 1 00:00:02 UTC 2001').toISOString().substr(0, 16); - const root = render( - } - />, - ); - expect(await root.findAllByText('Test')).toBeTruthy(); - }); - - it('shows the current date if `date` parameter is undefined', () => { - const handleDateChange = jasmine.createSpy(); - const currentDate = format(new Date(), 'MM/dd/yyyy HH:mm'); - - const root = render( - } - />, - ); - const datePicker = root.container.querySelector('.MuiOutlinedInput-input.MuiInputBase-input'); - expect(datePicker?.getAttribute('value')).toBe(currentDate); - }); -}); diff --git a/packages/react-components/lib/date-time-picker.tsx b/packages/react-components/lib/date-time-picker.tsx deleted file mode 100644 index 5640df84d..000000000 --- a/packages/react-components/lib/date-time-picker.tsx +++ /dev/null @@ -1,18 +0,0 @@ -import React from 'react'; -import { DateTimePickerProps, DateTimePicker, LocalizationProvider } from '@mui/lab'; -import AdapterDateFns from '@mui/lab/AdapterDateFns'; -import { format } from 'date-fns'; - -export default function DateAndTimePickers(props: DateTimePickerProps): React.ReactElement { - const { label, value, ...rest } = props; - return ( - - - - ); -} diff --git a/packages/react-components/lib/index.ts b/packages/react-components/lib/index.ts index 002ad59ba..bdc90588f 100644 --- a/packages/react-components/lib/index.ts +++ b/packages/react-components/lib/index.ts @@ -7,7 +7,6 @@ export * from './appbar-tab'; export * from './color-manager'; export * from './commands'; export * from './confirmation-dialog'; -export * from './date-time-picker'; export * from './doors'; export * from './error-overlay'; export * from './error-snackbar'; @@ -15,6 +14,7 @@ export * from './form-inputs'; export * from './header-bar'; export * from './lifts'; export * from './loading'; +export * from './locale'; export * from './logo-button'; export * from './map'; export * from './navigation-bar'; diff --git a/packages/react-components/lib/locale.tsx b/packages/react-components/lib/locale.tsx new file mode 100644 index 000000000..27ca2c750 --- /dev/null +++ b/packages/react-components/lib/locale.tsx @@ -0,0 +1,34 @@ +import { LocalizationProvider as MuiLocalizationProvider } from '@mui/lab'; +import AdapterDateFns from '@mui/lab/AdapterDateFns'; +import { Locale } from 'date-fns'; +import React from 'react'; + +export const LocaleContext = React.createContext(null); + +export const LocalizationProvider: React.FC = ({ children }) => { + const [locale, setLocale] = React.useState(null); + + React.useEffect(() => { + (async () => { + for (const lang of navigator.languages) { + try { + setLocale((await import(`date-fns/locale/${lang}`)).default); + return; + } catch { + continue; + } + } + setLocale((await import(`date-fns/locale/en-US`)).default); + })(); + }, []); + + return ( + locale && ( + + {children} + + ) + ); +}; + +export default LocalizationProvider; diff --git a/packages/react-components/lib/reports/default-date-form.spec.tsx b/packages/react-components/lib/reports/default-date-form.spec.tsx index 0f532c445..4e812b515 100644 --- a/packages/react-components/lib/reports/default-date-form.spec.tsx +++ b/packages/react-components/lib/reports/default-date-form.spec.tsx @@ -1,20 +1,17 @@ import { render } from '@testing-library/react'; -import { format } from 'date-fns'; import React from 'react'; +import { LocalizationProvider } from '..'; import { DefaultDatesForm } from './default-dates-form'; import { reportConfigProps } from './utils.spec'; describe('Default date form', () => { - it('smoke test', () => { - render(); - }); - - it('places correctly initial values', () => { - const currentDate = format(new Date(), 'MM/dd/yyyy HH:mm'); - const newConfig = { ...reportConfigProps, fromLogDate: new Date(), toLogDate: new Date() }; - const root = render(); - const getInputs = root.container.querySelectorAll('.MuiOutlinedInput-input.MuiInputBase-input'); - expect(getInputs[0].getAttribute('value')).toBe(currentDate); - expect(getInputs[1].getAttribute('value')).toBe(currentDate); + it('places correctly initial values', async () => { + const date = new Date(); + const newConfig = { ...reportConfigProps, fromLogDate: date, toLogDate: date }; + const root = render(, { wrapper: LocalizationProvider }); + const fromInput = await root.findByLabelText('From'); + expect(fromInput.getAttribute('data-unix')).toBe(date.valueOf().toString()); + const toInput = await root.findByLabelText('To'); + expect(toInput.getAttribute('data-unix')).toBe(date.valueOf().toString()); }); }); diff --git a/packages/react-components/lib/reports/default-dates-form.tsx b/packages/react-components/lib/reports/default-dates-form.tsx index 30b7dc0be..31661bb66 100644 --- a/packages/react-components/lib/reports/default-dates-form.tsx +++ b/packages/react-components/lib/reports/default-dates-form.tsx @@ -1,8 +1,7 @@ -import React from 'react'; -import { TextField, styled } from '@mui/material'; +import DateTimePicker from '@mui/lab/DateTimePicker'; +import { styled, TextField } from '@mui/material'; import Button from '@mui/material/Button'; -import DateAndTimePickers from '../date-time-picker'; - +import React from 'react'; import { LogQueryPayload } from '.'; interface DefaultDatesFormProps { @@ -36,19 +35,33 @@ export const DefaultDatesForm = (props: DefaultDatesFormProps): JSX.Element | nu return onSelectFromDate && onSelectToDate ? (
- } + data-unix-time="asdjs" + renderInput={(props) => ( + + )} /> - } + data-unix-time={toLogDate?.valueOf()} + renderInput={(props) => ( + + )} />
diff --git a/packages/react-components/lib/reports/log-management/search-log-form.tsx b/packages/react-components/lib/reports/log-management/search-log-form.tsx index 01510175c..0c4e3a3d2 100644 --- a/packages/react-components/lib/reports/log-management/search-log-form.tsx +++ b/packages/react-components/lib/reports/log-management/search-log-form.tsx @@ -1,12 +1,11 @@ -import React from 'react'; -import { TextField, SelectChangeEvent, styled } from '@mui/material'; -import Button from '@mui/material/Button'; -import { SearchFilter } from './search-filter'; -import DateAndTimePickers from '../../date-time-picker'; import { DateTimePickerProps } from '@mui/lab'; -import { LogLevel } from './log-level'; - +import DateTimePicker from '@mui/lab/DateTimePicker'; +import { SelectChangeEvent, styled, TextField } from '@mui/material'; +import Button from '@mui/material/Button'; +import React from 'react'; import { LogQueryPayload } from '.'; +import { LogLevel } from './log-level'; +import { SearchFilter } from './search-filter'; interface SearchLogFormProps { logLabelValues: { label: string; value: string }[]; @@ -101,14 +100,14 @@ export const SearchLogForm = (props: SearchLogFormProps): React.ReactElement => currentValue={logLevel} /> - } /> - { -// it('information renders correctly', () => { -// const robot = makeRandomRobot('test_robot', 'test_fleet', 1); -// const deliveryTask = makeTaskSummaryWithPhases('delivery_task', 1, 1); -// deliveryTask.task_profile.description.task_type.type = RmfTaskType.TYPE_DELIVERY; -// deliveryTask.task_profile.description.delivery.pickup_place_name = 'test_waypoint_1'; -// deliveryTask.task_profile.description.delivery.pickup_dispenser = 'test_dispenser'; -// deliveryTask.task_profile.description.delivery.dropoff_place_name = 'test_waypoint_2'; -// deliveryTask.task_profile.description.delivery.dropoff_ingestor = 'test_ingestor'; -// const task: Task = { -// summary: deliveryTask, -// progress: { status: '10' }, -// task_id: 'delivery_task', -// }; - -// const robot1 = { ...robot, tasks: [task] }; - -// const root = render(); - -// expect(root.getByRole('heading', { name: 'test_robot' })).toBeTruthy(); -// expect(root.getByRole('button', { name: 'delivery_task' })).toBeTruthy(); -// expect(root.getByRole('button', { name: 'test_waypoint_1' })).toBeTruthy(); -// expect(root.getByRole('button', { name: 'test_waypoint_2' })).toBeTruthy(); -// }); -// }); +describe('RobotInfo', () => { + it('information renders correctly', () => { + const root = render( + , + ); + expect(() => root.getByText('test_robot')).not.toThrow(); + expect(() => root.getByText('test_task')).not.toThrow(); + expect(() => root.getByText('50%')).not.toThrow(); // task progress + expect(() => root.getByText('60%')).not.toThrow(); // battery + expect(() => root.getByText(/.*underway/)).not.toThrow(); + expect(() => root.getByText(new Date(0).toLocaleString())).not.toThrow(); + }); +}); diff --git a/packages/react-components/lib/robots/robot-info.stories.tsx b/packages/react-components/lib/robots/robot-info.stories.tsx index 506c4bd2d..1e1f935f7 100644 --- a/packages/react-components/lib/robots/robot-info.stories.tsx +++ b/packages/react-components/lib/robots/robot-info.stories.tsx @@ -1,36 +1,23 @@ import { Meta, Story } from '@storybook/react'; import React from 'react'; -import { makeDefinedTask } from '../tasks/test-data.spec'; import { RobotInfo, RobotInfoProps } from './robot-info'; -import { makeRobot } from './test-utils.spec'; -import { Paper } from '@mui/material'; export default { - title: 'Robots/Info', + title: 'Robots/Detailed Info', component: RobotInfo, } as Meta; -export const Info: Story = (args) => { - return ( - - - - ); +export const Default: Story = (args) => { + return ; }; -const exampleRobot = makeRobot(); -const tasks = [ - makeDefinedTask('Loop', 'test', '1002', 3, 1), - makeDefinedTask('Delivery', 'test', '1004', 3, 1), - makeDefinedTask('Loop', 'test', '1007', 4, 1), -]; -const verboseRobot = { - fleet: 'fleet', - name: exampleRobot.name, - state: exampleRobot, - tasks, -}; +Default.storyName = 'Detailed Info'; -Info.args = { - robot: verboseRobot, +Default.args = { + robotName: 'Robot Name', + assignedTask: 'mytask', + battery: 0.5, + taskProgress: 0.5, + taskStatus: 'underway', + estFinishTime: Date.now(), }; diff --git a/packages/react-components/lib/robots/robot-info.tsx b/packages/react-components/lib/robots/robot-info.tsx index 7d84c8366..97be62993 100644 --- a/packages/react-components/lib/robots/robot-info.tsx +++ b/packages/react-components/lib/robots/robot-info.tsx @@ -1,10 +1,19 @@ -import { Button, Divider, Grid, Typography, useTheme, styled } from '@mui/material'; +import { Button, Divider, Grid, styled, Typography, useTheme } from '@mui/material'; import React from 'react'; -import { taskStateToStr } from '../tasks/utils'; -import { format } from 'date-fns'; import { CircularProgressBar } from './circular-progress-bar'; import { LinearProgressBar } from './linear-progress-bar'; -import { VerboseRobot } from './utils'; +import type { TaskState } from 'api-client'; + +function getTaskStatusDisplay(assignedTask?: string, taskStatus?: string) { + if (assignedTask && !taskStatus) { + return 'Unknown'; + } + if (assignedTask && taskStatus) { + return taskStatus; + } else { + return 'No Task'; + } +} const classes = { button: 'robot-info-button', @@ -18,42 +27,43 @@ const StyledDiv = styled('div')(() => ({ }, })); +type TaskStatus = Required['status']; + export interface RobotInfoProps { - robot: VerboseRobot; + robotName: string; + battery?: number; + assignedTask?: string; + taskStatus?: TaskStatus; + taskProgress?: number; + estFinishTime?: number; } -export function RobotInfo({ robot }: RobotInfoProps): JSX.Element { +export function RobotInfo({ + robotName, + battery, + assignedTask, + taskStatus, + taskProgress, + estFinishTime, +}: RobotInfoProps): JSX.Element { const theme = useTheme(); const [hasConcreteEndTime] = React.useState(false); - const currentTask = robot.current_task_state; - return ( - {robot.state.name} + {robotName}
- - {`Task Progress - ${currentTask ? taskStateToStr(currentTask) : 'No Task'}`} + + {`Task Progress - ${getTaskStatusDisplay(assignedTask, taskStatus)}`} - {currentTask && - currentTask.unix_millis_start_time && - currentTask.unix_millis_finish_time ? ( - - ) : ( - - )} + {taskProgress && } @@ -68,8 +78,7 @@ export function RobotInfo({ robot }: RobotInfoProps): JSX.Element { disableRipple={true} component="div" > - assigned task - {robot ? ` - ${robot.state.task_id}` : '-'} + {assignedTask || '-'} @@ -83,13 +92,8 @@ export function RobotInfo({ robot }: RobotInfoProps): JSX.Element { - - {`${ - robot.state.battery ? robot.state.battery * 100 : 0 - }%`} + + {`${battery ? battery * 100 : 0}%`} @@ -100,13 +104,7 @@ export function RobotInfo({ robot }: RobotInfoProps): JSX.Element { className={classes.button} disableRipple={true} > - time - {currentTask?.estimate_millis - ? ` - ${format( - new Date(currentTask.estimate_millis * 1 + Date.now()), - "hh:mm aaaaa'm'", - )}` - : '-'} + {estFinishTime !== undefined ? `${new Date(estFinishTime).toLocaleString()}` : '-'} diff --git a/packages/react-components/lib/robots/robot-panel.spec.tsx b/packages/react-components/lib/robots/robot-panel.spec.tsx deleted file mode 100644 index 7d482ad20..000000000 --- a/packages/react-components/lib/robots/robot-panel.spec.tsx +++ /dev/null @@ -1,43 +0,0 @@ -//import { render } from '@testing-library/react'; -//import userEvent from '@testing-library/user-event'; -//import React from 'react'; -// import { makeDefinedTask } from '../tasks/test-data.spec'; -//import { RobotPanel, RobotPanelProps } from './robot-panel'; -//import { makeRandomRobot } from './test-utils.spec'; -//import { VerboseRobot } from './utils'; - -//function makeFetchRobots(robots: VerboseRobot[]): RobotPanelProps['fetchVerboseRobots'] { -//return async () => { -//return robots; -//}; -//} - -// TODO(FIXME): Fix tests for Tasksv2 - -// describe('RobotPanel', () => { -// it('shows empty information when robot is clicked when there are no assigned tasks', async () => { -// const robots = [makeRandomRobot('test_robot1', 'test_fleet', 2)]; -// const root = render( -// , -// ); -// await userEvent.click(root.getByText('test_robot1')); -// expect(root.getByRole('heading', { name: 'test_robot1' })).toBeTruthy(); -// expect(root.getAllByRole('button', { name: '-' }).length).toBe(4); -// }); - -// it('shows detailed information when robot is clicked', async () => { -// const tasks = [ -// { ...makeDefinedTask('Loop', 'test_robot1', 'task_1', 3, 3), progress: { status: '10%' } }, -// ]; -// const robot = makeRandomRobot('test_robot1', 'test_fleet', 2); -// const verboseRobot = [{ ...robot, tasks }]; -// const root = render( -// , -// ); -// await userEvent.click(root.getByText('test_robot1')); -// expect(root.getByRole('progressbar')).toBeTruthy(); -// }); -// }); diff --git a/packages/react-components/lib/robots/robot-panel.stories.tsx b/packages/react-components/lib/robots/robot-panel.stories.tsx deleted file mode 100644 index 05e43b491..000000000 --- a/packages/react-components/lib/robots/robot-panel.stories.tsx +++ /dev/null @@ -1,57 +0,0 @@ -import { Meta, Story } from '@storybook/react'; -import React from 'react'; -import { makeDefinedTask } from '../tasks/test-data.spec'; -import { RobotPanel as RobotPanel_, RobotPanelProps } from './robot-panel'; -import { makeRandomRobot } from './test-utils.spec'; -import { VerboseRobot } from './utils'; - -export default { - title: 'Robots/Robot Panel', - component: RobotPanel_, - argTypes: { - fetchTasks: { - table: { - disable: true, - }, - }, - }, -} as Meta; - -export const RobotPanel: Story = (args) => { - return ( - <> - - - ); -}; - -const verboseRobots: VerboseRobot[] = [ - { - ...makeRandomRobot('test_robot1', 'test_fleet', 2), - tasks: [makeDefinedTask('Delivery', 'test_robot1', 'active_task_1', 3, 3)], - }, - { - ...makeRandomRobot('test_robot2', 'test_fleet', 1), - tasks: [makeDefinedTask('Loop', 'test_robot2', 'active_task_2', 4, 3)], - }, - { - ...makeRandomRobot('test_robot3', 'test_fleet', 3), - tasks: [makeDefinedTask('Clean', 'test_robot3', 'active_task_3', 4, 3)], - }, - { - ...makeRandomRobot('test_robot4', 'test_fleet', 4), - tasks: [makeDefinedTask('Loop', 'test_robot4', 'active_task_4', 4, 3)], - }, -]; - -async function fetchVerboseRobots(): Promise { - return verboseRobots; -} - -RobotPanel.args = { - fetchVerboseRobots, - verboseRobots, -}; diff --git a/packages/react-components/lib/robots/robot-panel.tsx b/packages/react-components/lib/robots/robot-panel.tsx deleted file mode 100644 index 0aacb900c..000000000 --- a/packages/react-components/lib/robots/robot-panel.tsx +++ /dev/null @@ -1,89 +0,0 @@ -import { Grid, Paper, TablePagination, Typography, styled } from '@mui/material'; -import React from 'react'; -import { RobotInfo } from './robot-info'; -import { RobotTable } from './robot-table'; -import { VerboseRobot } from './utils'; - -const classes = { - detailPanelContainer: 'robot-panel-detail-container', - robotTable: 'robot-panel-table', -}; -const StyledDiv = styled('div')(({ theme }) => ({ - [`& .${classes.detailPanelContainer}`]: { - width: 350, - padding: theme.spacing(2), - marginLeft: theme.spacing(2), - flex: '0 0 auto', - }, - [`& .${classes.robotTable}`]: { - height: '100%', - display: 'flex', - flexDirection: 'column', - }, -})); - -function NoSelectedRobot() { - return ( - - - Click on a robot to view more information - - - ); -} - -export interface RobotPanelProps - extends React.DetailedHTMLProps, HTMLDivElement> { - paginationOptions?: Omit, 'component'>; - verboseRobots: VerboseRobot[]; - onRobotZoom?: (robot: VerboseRobot) => void; -} - -// FIXME - change fetchVerboseRobots props to onRefresh -// and shift handleRefresh logic to the parent component -export function RobotPanel({ - paginationOptions, - verboseRobots, - onRobotZoom, - ...divProps -}: RobotPanelProps): JSX.Element { - const [selectedRobot, setSelectedRobot] = React.useState(undefined); - - const handleRefresh = async (selectedRobot?: VerboseRobot) => { - (async () => { - verboseRobots.forEach((robot) => { - if (selectedRobot && robot.state.name === selectedRobot.state.name) { - setSelectedRobot(robot); - } - }); - })(); - }; - - const handleRobotClick = async ( - _ev: React.MouseEvent, - robot: VerboseRobot, - ) => { - await handleRefresh(robot); - setSelectedRobot(robot); - onRobotZoom && onRobotZoom(robot); - }; - - return ( - - - - handleRefresh(selectedRobot)} - /> - - - {selectedRobot ? : } - - - - ); -} diff --git a/packages/react-components/lib/robots/robot-table.spec.tsx b/packages/react-components/lib/robots/robot-table.spec.tsx index 8767e03fa..8e873aebb 100644 --- a/packages/react-components/lib/robots/robot-table.spec.tsx +++ b/packages/react-components/lib/robots/robot-table.spec.tsx @@ -1,41 +1,24 @@ import { render } from '@testing-library/react'; +import { Status2 as RobotStatus } from 'api-client'; import React from 'react'; -import { RobotTable } from './robot-table'; -import { makeRandomRobot } from './test-utils.spec'; +import { RobotTable, RobotTableData } from './robot-table'; +import { makeRobot } from './test-utils.spec'; + +const allStatuses = Object.values(RobotStatus) as RobotStatus[]; describe('RobotTable', () => { it('shows all robots', () => { - const robots = [ - makeRandomRobot('test_robot1', 'test_fleet', 2), - makeRandomRobot('test_robot2', 'test_fleet', 1), - ]; - const root = render(); + const robots = [makeRobot({ name: 'test_robot1' }), makeRobot({ name: 'test_robot2' })]; + const tableData: RobotTableData[] = robots.map((robot) => ({ + name: robot.name, + })); + const root = render(); expect(root.getByText('test_robot1')).toBeTruthy(); expect(root.getByText('test_robot2')).toBeTruthy(); }); - it('smoke test for different robot states', () => { - const idleRobot = makeRandomRobot('test_robot1', 'test_fleet', 0); - const chargingRobot = makeRandomRobot('test_robot2', 'test_fleet', 1); - const movingRobot = makeRandomRobot('test_robot3', 'test_fleet', 2); - const pausedRobot = makeRandomRobot('test_robot4', 'test_fleet', 3); - const waitingRobot = makeRandomRobot('test_robot5', 'test_fleet', 4); - const emergencyRobot = makeRandomRobot('test_robot6', 'test_fleet', 5); - const goingHomeRobot = makeRandomRobot('test_robot7', 'test_fleet', 6); - const dockingRobot = makeRandomRobot('test_robot8', 'test_fleet', 7); - const errorRobot = makeRandomRobot('test_robot19', 'test_fleet', 8); - - const robots = [ - idleRobot, - chargingRobot, - movingRobot, - pausedRobot, - waitingRobot, - emergencyRobot, - goingHomeRobot, - dockingRobot, - errorRobot, - ]; + it('smoke test for different robot status', () => { + const robots = allStatuses.map((status) => makeRobot({ name: `${status}_robot`, status })); render(); }); @@ -43,7 +26,7 @@ describe('RobotTable', () => { const spy = jasmine.createSpy(); const root = render( { }); it('pagination is not shown when no pagination option is provided', () => { - const root = render(); + const root = render(); // NOTE: mui v5 is using the unicode char '–', different from '-'!! expect(root.queryByText('1–1 of 1')).toBeNull(); }); diff --git a/packages/react-components/lib/robots/robot-table.stories.tsx b/packages/react-components/lib/robots/robot-table.stories.tsx index 4e10649f0..9d38e0749 100644 --- a/packages/react-components/lib/robots/robot-table.stories.tsx +++ b/packages/react-components/lib/robots/robot-table.stories.tsx @@ -1,39 +1,11 @@ import { Meta, Story } from '@storybook/react'; import React from 'react'; -import { makeDefinedTask } from '../tasks/test-data.spec'; import { PaginationOptions, RobotTable, RobotTableProps } from './robot-table'; -import { makeRandomRobot } from './test-utils.spec'; -import { VerboseRobot } from './utils'; - -const verboseRobots: VerboseRobot[] = [ - { - ...makeRandomRobot('test_robot1', 'test_fleet', 2), - tasks: [makeDefinedTask('Delivery', 'test_robot1', 'active_task_1', 3, 3)], - }, - { - ...makeRandomRobot('test_robot2', 'test_fleet', 1), - tasks: [makeDefinedTask('Loop', 'test_robot2', 'active_task_2', 4, 3)], - }, - { - ...makeRandomRobot('test_robot3', 'test_fleet', 3), - tasks: [makeDefinedTask('Clean', 'test_robot3', 'active_task_3', 4, 3)], - }, - { - ...makeRandomRobot('test_robot4', 'test_fleet', 4), - tasks: [makeDefinedTask('Loop', 'test_robot4', 'active_task_4', 4, 3)], - }, -]; +import { RobotTableData } from './robot-table'; +import { Status2 as RobotStatus } from 'api-client'; export default { title: 'Robots/Table', - component: RobotTable, - argTypes: { - paginationOptions: { - control: { - disable: true, - }, - }, - }, } as Meta; export const Table: Story = (args) => { @@ -51,13 +23,25 @@ export const Table: Story = (args) => { ); }; +const allStatuses: RobotStatus[] = Object.values(RobotStatus) as RobotStatus[]; + +const robots: RobotTableData[] = []; +for (let i = 0; i < 12; ++i) { + robots.push({ + name: `Robot ${i + 1}`, + battery: Math.min(i / 10, 1), + status: allStatuses[i % allStatuses.length], + estFinishTime: Date.now() + i * 1000000, + }); +} + Table.args = { - robots: verboseRobots, + robots, }; diff --git a/packages/react-components/lib/robots/robot-table.tsx b/packages/react-components/lib/robots/robot-table.tsx index 3b688db52..17eb5159c 100644 --- a/packages/react-components/lib/robots/robot-table.tsx +++ b/packages/react-components/lib/robots/robot-table.tsx @@ -1,7 +1,9 @@ +import { Refresh as RefreshIcon } from '@mui/icons-material'; import { IconButton, Paper, PaperProps, + styled, Table, TableBody, TableCell, @@ -11,12 +13,9 @@ import { TableRow, Toolbar, Typography, - styled, } from '@mui/material'; -import type { TaskState } from 'api-client'; -import { Refresh as RefreshIcon } from '@mui/icons-material'; +import type { RobotState } from 'api-client'; import React from 'react'; -import { VerboseRobot } from '.'; const classes = { table: 'robot-table', @@ -59,60 +58,50 @@ const StyledPaper = styled((props: PaperProps) => )(({ theme }, })); -interface RobotRowProps { - verboseRobot: VerboseRobot; +type RobotStatus = Required['status']; + +export interface RobotTableData { + name: string; + status?: RobotStatus; + battery?: number; + estFinishTime?: number; +} + +interface RobotRowProps extends RobotTableData { onClick: React.MouseEventHandler; } -function RobotRow({ verboseRobot, onClick }: RobotRowProps) { - const getRobotModeClass = (robotMode: string) => { - switch (robotMode) { - case 'emergency': - return classes.robotErrorClass; - case 'charging': - return classes.robotChargingClass; - case 'working': - return classes.robotInMotionClass; - case 'idle': - case 'paused': - case 'waiting': - return classes.robotStoppedClass; - default: - return ''; - } - }; - const st = verboseRobot.state.status ? verboseRobot.state.status : ''; - const robotModeClass = getRobotModeClass(st); - const name = verboseRobot.state.name; - const battery = verboseRobot.state.battery ? verboseRobot.state.battery * 100 : 0; +function getRobotStatusClass(robotStatus?: RobotStatus) { + if (!robotStatus) { + return ''; + } + switch (robotStatus) { + case 'error': + return classes.robotErrorClass; + case 'charging': + return classes.robotChargingClass; + case 'working': + return classes.robotInMotionClass; + case 'idle': + case 'offline': + case 'shutdown': + case 'uninitialized': + return classes.robotStoppedClass; + } + return ''; +} - if (verboseRobot.current_task_state) { - const date = verboseRobot.current_task_state.estimate_millis - ? new Date(verboseRobot.current_task_state.estimate_millis).toISOString().substr(11, 8) - : '-'; +function RobotRow({ name, status, battery = 0, estFinishTime, onClick }: RobotRowProps) { + const robotStatusClass = getRobotStatusClass(status); - return ( - <> - - {name} - {date} - {battery}% - {st} - - - ); - } else { - return ( - <> - - {name} - {'-'} - {battery}% - {st} - - - ); - } + return ( + + {name} + {estFinishTime ? new Date(estFinishTime).toLocaleString() : '-'} + {battery * 100}% + {status} + + ); } export type PaginationOptions = Omit< @@ -125,11 +114,10 @@ export interface RobotTableProps extends PaperProps { * The current list of robots to display, when pagination is enabled, this should only * contain the robots for the current page. */ - robots: VerboseRobot[]; - fetchSelectedTask?: (taskId: string) => Promise; + robots: RobotTableData[]; paginationOptions?: PaginationOptions; onRefreshClick?: React.MouseEventHandler; - onRobotClick?(ev: React.MouseEvent, robot: VerboseRobot): void; + onRobotClick?(ev: React.MouseEvent, robotName: string): void; } export function RobotTable({ @@ -154,20 +142,19 @@ export function RobotTable({ Robot Name - Active Task Duration + Est. Task Finish Time Battery - State + Status - {robots && - robots.map((robot, robot_id) => ( - onRobotClick && onRobotClick(ev, robot)} - /> - ))} + {robots.map((robot, robot_id) => ( + onRobotClick && onRobotClick(ev, robot.name)} + /> + ))}
diff --git a/packages/react-components/lib/robots/test-utils.spec.ts b/packages/react-components/lib/robots/test-utils.spec.ts index 492e7015c..04c3b33f7 100644 --- a/packages/react-components/lib/robots/test-utils.spec.ts +++ b/packages/react-components/lib/robots/test-utils.spec.ts @@ -1,69 +1,14 @@ -import type { Location, RobotMode, RobotState } from 'api-client'; -import { RobotMode as RmfRobotMode } from 'rmf-models'; -import { VerboseRobot } from '.'; +import type { RobotState } from 'api-client'; -export function allRobotModes(): RobotMode[] { - return [ - { mode: RmfRobotMode.MODE_ADAPTER_ERROR, mode_request_id: 0 }, - { mode: RmfRobotMode.MODE_CHARGING, mode_request_id: 0 }, - { mode: RmfRobotMode.MODE_DOCKING, mode_request_id: 0 }, - { mode: RmfRobotMode.MODE_EMERGENCY, mode_request_id: 0 }, - { mode: RmfRobotMode.MODE_GOING_HOME, mode_request_id: 0 }, - { mode: RmfRobotMode.MODE_IDLE, mode_request_id: 0 }, - { mode: RmfRobotMode.MODE_MOVING, mode_request_id: 0 }, - { mode: RmfRobotMode.MODE_PAUSED, mode_request_id: 0 }, - { mode: RmfRobotMode.MODE_WAITING, mode_request_id: 0 }, - { mode: -1, mode_request_id: 0 }, - ]; -} - -export function makeRobot(robotState?: Partial): RobotState { +export function makeRobot(robotState?: Partial): Required { return { name: 'test', - battery_percent: 1, - location: { level_name: 'test_level', x: 0, y: 0, yaw: 0, t: { sec: 0, nanosec: 0 }, index: 0 }, - mode: { mode: RmfRobotMode.MODE_PAUSED, mode_request_id: 0 }, - model: 'test_model', + battery: 1, + location: { map: 'test_level', x: 0, y: 0, yaw: 0 }, + status: 'idle', task_id: 'test_task_id', - path: [], - seq: 0, + issues: [], + unix_millis_time: 0, ...robotState, }; } - -function randomNumber(decimal: number): number { - const r = Math.round(Math.random() * decimal); - return r; -} - -export function createLocation(level_name: string): Location { - return { - t: { sec: 0, nanosec: 0 }, - x: randomNumber(10), - y: randomNumber(10), - yaw: randomNumber(10), - level_name: level_name, - index: randomNumber(10), - }; -} - -export function makeRandomRobot(name: string, model: string, mode: number): VerboseRobot { - const task_id = randomNumber(1000); - const battery_percent = randomNumber(100); - - return { - fleet: 'fleet', - name: name, - state: { - name: name, - model: model, - task_id: task_id.toString(), - seq: 1, - mode: { mode: mode, mode_request_id: 0 }, - battery_percent: battery_percent, - location: createLocation('Level_1'), - path: [], - }, - tasks: [], - }; -} diff --git a/packages/react-components/lib/robots/utils.ts b/packages/react-components/lib/robots/utils.ts index fd5b39472..f4c65003c 100644 --- a/packages/react-components/lib/robots/utils.ts +++ b/packages/react-components/lib/robots/utils.ts @@ -1,5 +1,4 @@ import { RobotMode as RmfRobotMode } from 'rmf-models'; -import type { RobotState, TaskState } from 'api-client'; /** * Returns a uniquely identifiable string representing a robot. @@ -30,8 +29,3 @@ export function robotModeToString(robotMode: RmfRobotMode): string { return `Unknown (${robotMode.mode})`; } } - -export interface VerboseRobot { - state: RobotState; - current_task_state?: TaskState; -} diff --git a/packages/react-components/lib/tasks/utils.ts b/packages/react-components/lib/tasks/utils.ts index d316031b2..d303b487a 100644 --- a/packages/react-components/lib/tasks/utils.ts +++ b/packages/react-components/lib/tasks/utils.ts @@ -1,16 +1,6 @@ import { TaskType as RmfTaskType } from 'rmf-models'; import type { TaskState } from 'api-client'; -export function taskStateToStr(taskState: TaskState): string { - if (taskState.active) return 'active'; - if (taskState.cancellation) return 'cancelled'; - if (taskState.killed) return 'killed'; - if (taskState.pending?.length === 0) return 'completed'; - else { - return 'unknown'; - } -} - export function taskTypeToStr(taskType: number): string { switch (taskType) { case RmfTaskType.TYPE_CHARGE_BATTERY: From cdc68ae1cf0f411d88301712da2a79761a770c72 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Wed, 16 Feb 2022 18:25:03 +0800 Subject: [PATCH 61/79] add time endpoint Signed-off-by: Teo Koon Peng --- packages/api-client/lib/openapi/api.ts | 66 +++++++++++++++++++ packages/api-client/lib/version.ts | 2 +- packages/api-server/api_server/routes/main.py | 9 +++ 3 files changed, 76 insertions(+), 1 deletion(-) diff --git a/packages/api-client/lib/openapi/api.ts b/packages/api-client/lib/openapi/api.ts index ee89e5f17..3800184c6 100644 --- a/packages/api-client/lib/openapi/api.ts +++ b/packages/api-client/lib/openapi/api.ts @@ -4087,6 +4087,38 @@ export const DefaultApiAxiosParamCreator = function (configuration?: Configurati options: localVarRequestOptions, }; }, + /** + * Get the current rmf time in unix milliseconds + * @summary Get Time + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTimeTimeGet: async (options: AxiosRequestConfig = {}): Promise => { + const localVarPath = `/time`; + // 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: 'GET', ...baseOptions, ...options }; + const localVarHeaderParameter = {} as any; + const localVarQueryParameter = {} as any; + + setSearchParams(localVarUrlObj, localVarQueryParameter); + let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; + localVarRequestOptions.headers = { + ...localVarHeaderParameter, + ...headersFromBaseOptions, + ...options.headers, + }; + + return { + url: toPathString(localVarUrlObj), + options: localVarRequestOptions, + }; + }, /** * Get the currently logged in user * @summary Get User @@ -4174,6 +4206,18 @@ export const DefaultApiFp = function (configuration?: Configuration) { await localVarAxiosParamCreator.getEffectivePermissionsPermissionsGet(options); return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); }, + /** + * Get the current rmf time in unix milliseconds + * @summary Get Time + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + async getTimeTimeGet( + options?: AxiosRequestConfig, + ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getTimeTimeGet(options); + return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration); + }, /** * Get the currently logged in user * @summary Get User @@ -4223,6 +4267,15 @@ export const DefaultApiFactory = function ( .getEffectivePermissionsPermissionsGet(options) .then((request) => request(axios, basePath)); }, + /** + * Get the current rmf time in unix milliseconds + * @summary Get Time + * @param {*} [options] Override http request option. + * @throws {RequiredError} + */ + getTimeTimeGet(options?: any): AxiosPromise { + return localVarFp.getTimeTimeGet(options).then((request) => request(axios, basePath)); + }, /** * Get the currently logged in user * @summary Get User @@ -4264,6 +4317,19 @@ export class DefaultApi extends BaseAPI { .then((request) => request(this.axios, this.basePath)); } + /** + * Get the current rmf time in unix milliseconds + * @summary Get Time + * @param {*} [options] Override http request option. + * @throws {RequiredError} + * @memberof DefaultApi + */ + public getTimeTimeGet(options?: AxiosRequestConfig) { + return DefaultApiFp(this.configuration) + .getTimeTimeGet(options) + .then((request) => request(this.axios, this.basePath)); + } + /** * Get the currently logged in user * @summary Get User diff --git a/packages/api-client/lib/version.ts b/packages/api-client/lib/version.ts index ef81d1070..ead9c4226 100644 --- a/packages/api-client/lib/version.ts +++ b/packages/api-client/lib/version.ts @@ -3,6 +3,6 @@ import { version as rmfModelVer } from 'rmf-models'; export const version = { rmfModels: rmfModelVer, - rmfServer: '74c154d735aea685a59c3e82bbdcdfff273a96db', + rmfServer: '9dec007143fd6aa3491d7a1bf817feca3c1c099b', openapiGenerator: '5.4.0', }; diff --git a/packages/api-server/api_server/routes/main.py b/packages/api-server/api_server/routes/main.py index 88ccff8c9..e379640b6 100644 --- a/packages/api-server/api_server/routes/main.py +++ b/packages/api-server/api_server/routes/main.py @@ -2,6 +2,7 @@ from fastapi import APIRouter, Depends +from api_server import clock from api_server.authenticator import user_dep from api_server.models import Permission, User from api_server.models.tortoise_models import ResourcePermission @@ -31,3 +32,11 @@ async def get_effective_permissions(user: User = Depends(user_dep)): Permission.construct(authz_grp=p["authz_grp"], action=p["action"]) for p in perms ] + + +@router.get("/time", response_model=int) +async def get_time(): + """ + Get the current rmf time in unix milliseconds + """ + return clock.now() From f87b0df8c2995d647719f9980832c42d80568b43 Mon Sep 17 00:00:00 2001 From: Charayaphan Nakorn Boon Han Date: Wed, 16 Feb 2022 20:09:05 +0800 Subject: [PATCH 62/79] rudimentary working delivery panel Signed-off-by: Charayaphan Nakorn Boon Han --- .../lib/tasks/create-task.tsx | 158 ++++++++++++++++++ 1 file changed, 158 insertions(+) diff --git a/packages/react-components/lib/tasks/create-task.tsx b/packages/react-components/lib/tasks/create-task.tsx index de5def7a4..de31b11d7 100644 --- a/packages/react-components/lib/tasks/create-task.tsx +++ b/packages/react-components/lib/tasks/create-task.tsx @@ -233,6 +233,164 @@ function DeliveryTaskForm({ /> + + + + newValue !== null && + onChange({ + ...taskDesc, + pickup: { + ...taskDesc.pickup, + payload: { + ...taskDesc.pickup.payload, + sku: newValue, + }, + }, + }) + } + onBlur={(ev) => + onChange({ + ...taskDesc, + pickup: { + ...taskDesc.dropoff, + payload: { + ...taskDesc.pickup.payload, + sku: (ev.target as HTMLInputElement).value, + }, + }, + }) + } + renderInput={(params) => } + /> + + + + newValue !== null && + onChange({ + ...taskDesc, + pickup: { + ...taskDesc.pickup, + payload: { + ...taskDesc.pickup.payload, + quantity: parseInt(newValue), + }, + }, + }) + } + onBlur={(ev) => + onChange({ + ...taskDesc, + pickup: { + ...taskDesc.pickup, + payload: { + ...taskDesc.pickup.payload, + quantity: parseInt((ev.target as HTMLInputElement).value), + }, + }, + }) + } + renderInput={(params) => ( + + )} + /> + + + + newValue !== null && + onChange({ + ...taskDesc, + dropoff: { + ...taskDesc.dropoff, + payload: { + ...taskDesc.dropoff.payload, + sku: newValue, + }, + }, + }) + } + onBlur={(ev) => + onChange({ + ...taskDesc, + dropoff: { + ...taskDesc.dropoff, + payload: { + ...taskDesc.dropoff.payload, + sku: (ev.target as HTMLInputElement).value, + }, + }, + }) + } + renderInput={(params) => } + /> + + + + newValue !== null && + onChange({ + ...taskDesc, + dropoff: { + ...taskDesc.dropoff, + payload: { + ...taskDesc.dropoff.payload, + quantity: parseInt(newValue), + }, + }, + }) + } + onBlur={(ev) => + onChange({ + ...taskDesc, + dropoff: { + ...taskDesc.dropoff, + payload: { + ...taskDesc.dropoff.payload, + quantity: parseInt((ev.target as HTMLInputElement).value), + }, + }, + }) + } + renderInput={(params) => ( + + )} + /> + + ); } From 80dcaba917d6ef4cc6fd9d499760f899e2f38615 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 17 Feb 2022 15:28:28 +0800 Subject: [PATCH 63/79] fix tests Signed-off-by: Teo Koon Peng --- .../lib/reports/default-date-form.spec.tsx | 10 +++++----- .../dispenser-state-report.spec.tsx | 13 ++++++++----- .../door-state/door-state-report.spec.tsx | 13 ++++++++----- .../fleet-state/fleet-state-report.spec.tsx | 11 +++++++---- .../lib/reports/health/health-report.spec.tsx | 9 ++++++--- .../ingestor-state-report.spec.tsx | 11 +++++++---- .../lift-state/lift-state-report.spec.tsx | 11 +++++++---- .../log-management/log-management.spec.tsx | 5 ++++- .../log-management/search-log-form.spec.tsx | 16 ++++------------ .../task-summary/task-summary-report.spec.tsx | 11 +++++++---- .../lib/tasks/task-timeline.spec.tsx | 5 +++-- .../react-components/lib/tasks/task-timeline.tsx | 7 +++---- packages/react-components/lib/test/locale.tsx | 7 +++++++ 13 files changed, 76 insertions(+), 53 deletions(-) create mode 100644 packages/react-components/lib/test/locale.tsx diff --git a/packages/react-components/lib/reports/default-date-form.spec.tsx b/packages/react-components/lib/reports/default-date-form.spec.tsx index 4e812b515..f30a4d8e6 100644 --- a/packages/react-components/lib/reports/default-date-form.spec.tsx +++ b/packages/react-components/lib/reports/default-date-form.spec.tsx @@ -1,17 +1,17 @@ import { render } from '@testing-library/react'; import React from 'react'; -import { LocalizationProvider } from '..'; +import { TestLocalizationProvider } from '../test/locale'; import { DefaultDatesForm } from './default-dates-form'; import { reportConfigProps } from './utils.spec'; describe('Default date form', () => { - it('places correctly initial values', async () => { + it('places correctly initial values', () => { const date = new Date(); const newConfig = { ...reportConfigProps, fromLogDate: date, toLogDate: date }; - const root = render(, { wrapper: LocalizationProvider }); - const fromInput = await root.findByLabelText('From'); + const root = render(, { wrapper: TestLocalizationProvider }); + const fromInput = root.getByLabelText('From'); expect(fromInput.getAttribute('data-unix')).toBe(date.valueOf().toString()); - const toInput = await root.findByLabelText('To'); + const toInput = root.getByLabelText('To'); expect(toInput.getAttribute('data-unix')).toBe(date.valueOf().toString()); }); }); diff --git a/packages/react-components/lib/reports/dispenser-state/dispenser-state-report.spec.tsx b/packages/react-components/lib/reports/dispenser-state/dispenser-state-report.spec.tsx index 2cc42dc6f..695f346af 100644 --- a/packages/react-components/lib/reports/dispenser-state/dispenser-state-report.spec.tsx +++ b/packages/react-components/lib/reports/dispenser-state/dispenser-state-report.spec.tsx @@ -3,8 +3,9 @@ import userEvent from '@testing-library/user-event'; import React from 'react'; import { getDispenserLogs, reportConfigProps } from '../utils.spec'; import { DispenserStateReport } from './dispenser-state-report'; +import { TestLocalizationProvider } from '../../test/locale'; -const getLogsPromise = async () => await getDispenserLogs(); +const getLogsPromise = async () => getDispenserLogs(); it('smoke test', async () => { await waitFor(() => { @@ -14,19 +15,21 @@ it('smoke test', async () => { it('doesn`t shows the table when logs list is empty', async () => { await waitFor(() => { - render( await []} />); + render( []} />); }); expect(screen.queryByText('Dispenser State')).toBeFalsy(); }); -it('calls the retrieve log function when the button is clicked', async () => { +it('calls the retrieve log function when the button is clicked', () => { const getLogsPromiseMock = jasmine.createSpy(); const getLogsPromise = async () => { getLogsPromiseMock(); - return await getDispenserLogs(); + return getDispenserLogs(); }; - render(); + render(, { + wrapper: TestLocalizationProvider, + }); expect(screen.getByRole('button', { name: /Retrieve Logs/i })).toBeTruthy(); userEvent.click(screen.getByRole('button', { name: /Retrieve Logs/i })); expect(getLogsPromiseMock).toHaveBeenCalled(); diff --git a/packages/react-components/lib/reports/door-state/door-state-report.spec.tsx b/packages/react-components/lib/reports/door-state/door-state-report.spec.tsx index 682f28d0a..f3b63cbda 100644 --- a/packages/react-components/lib/reports/door-state/door-state-report.spec.tsx +++ b/packages/react-components/lib/reports/door-state/door-state-report.spec.tsx @@ -1,10 +1,11 @@ import { render, screen, waitFor } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React from 'react'; +import { TestLocalizationProvider } from '../../test/locale'; import { getDoorLogs, reportConfigProps } from '../utils.spec'; import { DoorStateReport } from './door-state-report'; -const getLogsPromise = async () => await getDoorLogs(); +const getLogsPromise = async () => getDoorLogs(); it('smoke test', async () => { await waitFor(() => { @@ -14,19 +15,21 @@ it('smoke test', async () => { it('doesn`t shows the table when logs list is empty', async () => { await waitFor(() => { - render( await []} />); + render( []} />); }); expect(screen.queryByText('Door State')).toBeFalsy(); }); -it('calls the retrieve log function when the button is clicked', async () => { +it('calls the retrieve log function when the button is clicked', () => { const getLogsPromiseMock = jasmine.createSpy(); const getLogsPromise = async () => { getLogsPromiseMock(); - return await getDoorLogs(); + return getDoorLogs(); }; - render(); + render(, { + wrapper: TestLocalizationProvider, + }); expect(screen.getByRole('button', { name: /Retrieve Logs/i })).toBeTruthy(); userEvent.click(screen.getByRole('button', { name: /Retrieve Logs/i })); expect(getLogsPromiseMock).toHaveBeenCalled(); diff --git a/packages/react-components/lib/reports/fleet-state/fleet-state-report.spec.tsx b/packages/react-components/lib/reports/fleet-state/fleet-state-report.spec.tsx index be01305c3..7acdd96c6 100644 --- a/packages/react-components/lib/reports/fleet-state/fleet-state-report.spec.tsx +++ b/packages/react-components/lib/reports/fleet-state/fleet-state-report.spec.tsx @@ -1,10 +1,11 @@ import { render, screen, waitFor } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React from 'react'; +import { TestLocalizationProvider } from '../../test/locale'; import { getFleetLogs, reportConfigProps } from '../utils.spec'; import { FleetStateReport } from './fleet-state-report'; -const getLogsPromise = async () => await getFleetLogs(); +const getLogsPromise = async () => getFleetLogs(); it('smoke test', async () => { await waitFor(() => { @@ -14,7 +15,7 @@ it('smoke test', async () => { it('doesn`t shows the table when logs list is empty', async () => { await waitFor(() => { - render( await []} />); + render( []} />); }); expect(screen.queryByText('Fleet State')).toBeFalsy(); @@ -24,9 +25,11 @@ it('calls the retrieve log function when the button is clicked', async () => { const getLogsPromiseMock = jasmine.createSpy(); const getLogsPromise = async () => { getLogsPromiseMock(); - return await getFleetLogs(); + return getFleetLogs(); }; - render(); + render(, { + wrapper: TestLocalizationProvider, + }); expect(screen.getByRole('button', { name: /Retrieve Logs/i })).toBeTruthy(); userEvent.click(screen.getByRole('button', { name: /Retrieve Logs/i })); expect(getLogsPromiseMock).toHaveBeenCalled(); diff --git a/packages/react-components/lib/reports/health/health-report.spec.tsx b/packages/react-components/lib/reports/health/health-report.spec.tsx index a948662b4..8d9ac27c2 100644 --- a/packages/react-components/lib/reports/health/health-report.spec.tsx +++ b/packages/react-components/lib/reports/health/health-report.spec.tsx @@ -1,10 +1,11 @@ import { render, screen, waitFor } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React from 'react'; +import { TestLocalizationProvider } from '../../test/locale'; import { getHealthLogs, reportConfigProps } from '../utils.spec'; import { HealthReport } from './health-report'; -const getLogsPromise = async () => await getHealthLogs(); +const getLogsPromise = async () => getHealthLogs(); it('smoke test', async () => { await waitFor(() => { @@ -24,9 +25,11 @@ it('calls the retrieve log function when the button is clicked', async () => { const getLogsPromiseMock = jasmine.createSpy(); const getLogsPromise = async () => { getLogsPromiseMock(); - return await getHealthLogs(); + return getHealthLogs(); }; - render(); + render(, { + wrapper: TestLocalizationProvider, + }); expect(screen.getByRole('button', { name: /Retrieve Logs/i })).toBeTruthy(); userEvent.click(screen.getByRole('button', { name: /Retrieve Logs/i })); expect(getLogsPromiseMock).toHaveBeenCalled(); diff --git a/packages/react-components/lib/reports/ingestor-state/ingestor-state-report.spec.tsx b/packages/react-components/lib/reports/ingestor-state/ingestor-state-report.spec.tsx index afbc7171a..f46ea6926 100644 --- a/packages/react-components/lib/reports/ingestor-state/ingestor-state-report.spec.tsx +++ b/packages/react-components/lib/reports/ingestor-state/ingestor-state-report.spec.tsx @@ -1,10 +1,11 @@ import { render, screen, waitFor } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React from 'react'; +import { TestLocalizationProvider } from '../../test/locale'; import { getIngestorLogs, reportConfigProps } from '../utils.spec'; import { IngestorStateReport } from './ingestor-state-report'; -const getLogsPromise = async () => await getIngestorLogs(); +const getLogsPromise = async () => getIngestorLogs(); it('smoke test', async () => { await waitFor(() => { @@ -14,7 +15,7 @@ it('smoke test', async () => { it('doesn`t shows the table when logs list is empty', async () => { await waitFor(() => { - render( await []} />); + render( []} />); }); expect(screen.queryByText('Ingestor State')).toBeFalsy(); @@ -24,9 +25,11 @@ it('calls the retrieve log function when the button is clicked', async () => { const getLogsPromiseMock = jasmine.createSpy(); const getLogsPromise = async () => { getLogsPromiseMock(); - return await getIngestorLogs(); + return getIngestorLogs(); }; - render(); + render(, { + wrapper: TestLocalizationProvider, + }); expect(screen.getByRole('button', { name: /Retrieve Logs/i })).toBeTruthy(); userEvent.click(screen.getByRole('button', { name: /Retrieve Logs/i })); expect(getLogsPromiseMock).toHaveBeenCalled(); diff --git a/packages/react-components/lib/reports/lift-state/lift-state-report.spec.tsx b/packages/react-components/lib/reports/lift-state/lift-state-report.spec.tsx index 2b6fe8d8d..917e380f1 100644 --- a/packages/react-components/lib/reports/lift-state/lift-state-report.spec.tsx +++ b/packages/react-components/lib/reports/lift-state/lift-state-report.spec.tsx @@ -1,10 +1,11 @@ import { render, screen, waitFor } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React from 'react'; +import { TestLocalizationProvider } from '../../test/locale'; import { getLiftLogs, reportConfigProps } from '../utils.spec'; import { LiftStateReport } from './lift-state-report'; -const getLogsPromise = async () => await getLiftLogs(); +const getLogsPromise = async () => getLiftLogs(); it('smoke test', async () => { await waitFor(() => { @@ -14,7 +15,7 @@ it('smoke test', async () => { it('doesn`t shows the table when logs list is empty', async () => { await waitFor(() => { - render( await []} />); + render( []} />); }); expect(screen.queryByText('Lift State')).toBeFalsy(); @@ -24,9 +25,11 @@ it('calls the retrieve log function when the button is clicked', async () => { const getLogsPromiseMock = jasmine.createSpy(); const getLogsPromise = async () => { getLogsPromiseMock(); - return await getLiftLogs(); + return getLiftLogs(); }; - render(); + render(, { + wrapper: TestLocalizationProvider, + }); expect(screen.getByRole('button', { name: /Retrieve Logs/i })).toBeTruthy(); userEvent.click(screen.getByRole('button', { name: /Retrieve Logs/i })); expect(getLogsPromiseMock).toHaveBeenCalled(); diff --git a/packages/react-components/lib/reports/log-management/log-management.spec.tsx b/packages/react-components/lib/reports/log-management/log-management.spec.tsx index 3c97c8fcc..3f834a572 100644 --- a/packages/react-components/lib/reports/log-management/log-management.spec.tsx +++ b/packages/react-components/lib/reports/log-management/log-management.spec.tsx @@ -2,6 +2,7 @@ import { render, waitFor } from '@testing-library/react'; import React from 'react'; import { LogManagement } from './log-management'; import { LogRowsType } from './log-table'; +import { TestLocalizationProvider } from '../../test/locale'; const getLogLabels = () => [ { label: 'Web Server', value: 'web-server' }, @@ -27,6 +28,8 @@ const getLabelsPromise = async () => await getLogLabels(); it('smoke test', async () => { // Added the waitFor because this component is updating a state inside a useEffect. await waitFor(() => { - render(); + render(, { + wrapper: TestLocalizationProvider, + }); }); }); diff --git a/packages/react-components/lib/reports/log-management/search-log-form.spec.tsx b/packages/react-components/lib/reports/log-management/search-log-form.spec.tsx index 02b0800d6..483468a2d 100644 --- a/packages/react-components/lib/reports/log-management/search-log-form.spec.tsx +++ b/packages/react-components/lib/reports/log-management/search-log-form.spec.tsx @@ -1,6 +1,6 @@ import { render } from '@testing-library/react'; -import { format } from 'date-fns'; import React from 'react'; +import { TestLocalizationProvider } from '../../test/locale'; import { SearchLogForm } from './search-log-form'; describe('Search log form tests', () => { @@ -10,16 +10,8 @@ describe('Search log form tests', () => { ]; it('smoke test', () => { - render(); - }); - - it('places correctly initial values', () => { - const root = render(); - expect(root.getByText('ALL')).toBeTruthy(); - const currentDate = format(new Date(), 'MM/dd/yyyy HH:mm'); - const fromDateInput = root.container.querySelector('#From'); - const toDateInput = root.container.querySelector('#To'); - expect(fromDateInput?.getAttribute('value')).toBe(currentDate); - expect(toDateInput?.getAttribute('value')).toBe(currentDate); + render(, { + wrapper: TestLocalizationProvider, + }); }); }); diff --git a/packages/react-components/lib/reports/task-summary/task-summary-report.spec.tsx b/packages/react-components/lib/reports/task-summary/task-summary-report.spec.tsx index 4dfe84265..fd86510e8 100644 --- a/packages/react-components/lib/reports/task-summary/task-summary-report.spec.tsx +++ b/packages/react-components/lib/reports/task-summary/task-summary-report.spec.tsx @@ -1,10 +1,11 @@ import { render, screen, waitFor } from '@testing-library/react'; import userEvent from '@testing-library/user-event'; import React from 'react'; +import { TestLocalizationProvider } from '../../test/locale'; import { getTaskSummaryLogs, reportConfigProps } from '../utils.spec'; import { TaskSummaryReport } from './task-summary-report'; -const getLogsPromise = async () => await getTaskSummaryLogs(); +const getLogsPromise = async () => getTaskSummaryLogs(); it('smoke test', async () => { await waitFor(() => { @@ -14,7 +15,7 @@ it('smoke test', async () => { it('does not show the table when the logs list is empty', async () => { await waitFor(() => { - render( await []} />); + render( []} />); }); expect(screen.queryByText('Task Summary')).toBeFalsy(); @@ -24,10 +25,12 @@ it('calls the Retrieve Logs function when the button is clicked', async () => { const getLogsPromiseMock = jasmine.createSpy(); const getLogsPromise = async () => { getLogsPromiseMock(); - return await getTaskSummaryLogs(); + return getTaskSummaryLogs(); }; - render(); + render(, { + wrapper: TestLocalizationProvider, + }); const retrieveLogsButton = screen.getByRole('button', { name: /Retrieve Logs/i }); expect(retrieveLogsButton).toBeTruthy(); userEvent.click(retrieveLogsButton); diff --git a/packages/react-components/lib/tasks/task-timeline.spec.tsx b/packages/react-components/lib/tasks/task-timeline.spec.tsx index 103907184..a43540d5f 100644 --- a/packages/react-components/lib/tasks/task-timeline.spec.tsx +++ b/packages/react-components/lib/tasks/task-timeline.spec.tsx @@ -4,12 +4,13 @@ import { TaskTimeline } from './task-timeline'; import { makeTaskState } from './test-data.spec'; describe('Task Timeline', () => { - // FIXME: sample phases has no start time it('shows the time for each phase', () => { const task = makeTaskState('task_0'); + Object.values(task.phases).forEach((p, idx) => { + p.unix_millis_start_time = 1000 * idx; + }); const root = render(); Object.values(task.phases).forEach((p) => { - expect(p.unix_millis_start_time).toBeTruthy(); const expectedTime = new Date(p.unix_millis_start_time).toLocaleTimeString(); expect(() => root.getByText(expectedTime)).not.toThrow(); }); diff --git a/packages/react-components/lib/tasks/task-timeline.tsx b/packages/react-components/lib/tasks/task-timeline.tsx index 006d8860b..0fe30eb82 100644 --- a/packages/react-components/lib/tasks/task-timeline.tsx +++ b/packages/react-components/lib/tasks/task-timeline.tsx @@ -15,8 +15,7 @@ import { } from '@mui/lab'; import { styled } from '@mui/material'; import Typography from '@mui/material/Typography'; -import { format } from 'date-fns'; -import { TaskState, Phase, EventState, Status } from 'api-client'; +import { EventState, Phase, Status, TaskState } from 'api-client'; import React from 'react'; interface TimeLinePropsWithRef extends TimelineProps { @@ -123,8 +122,8 @@ function RenderPhase(phase: Phase) { - {phase.unix_millis_start_time - ? format(new Date(phase.unix_millis_start_time), "hh:mm:ss aaaaa'm'") + {phase.unix_millis_start_time != null + ? new Date(phase.unix_millis_start_time).toLocaleTimeString() : null} diff --git a/packages/react-components/lib/test/locale.tsx b/packages/react-components/lib/test/locale.tsx new file mode 100644 index 000000000..b629e3425 --- /dev/null +++ b/packages/react-components/lib/test/locale.tsx @@ -0,0 +1,7 @@ +import { LocalizationProvider as MuiLocalizationProvider } from '@mui/lab'; +import AdapterDateFns from '@mui/lab/AdapterDateFns'; +import React from 'react'; + +export const TestLocalizationProvider: React.FC = ({ children }) => { + return {children}; +}; From 5d50ab2952bc025c919a6a65470eff4945cf2df2 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 17 Feb 2022 17:38:11 +0800 Subject: [PATCH 64/79] fix robot page on dashboard Signed-off-by: Teo Koon Peng --- packages/dashboard/rmf-launcher.js | 4 +- .../src/components/rmf-app/index.tsx | 1 + .../src/components/robots/robot-page.tsx | 211 ++++++++++++------ .../lib/robots/robot-table.tsx | 7 - 4 files changed, 150 insertions(+), 73 deletions(-) diff --git a/packages/dashboard/rmf-launcher.js b/packages/dashboard/rmf-launcher.js index cca1b18db..195dc4e34 100644 --- a/packages/dashboard/rmf-launcher.js +++ b/packages/dashboard/rmf-launcher.js @@ -45,9 +45,9 @@ exports.LocalLauncher = class { } const headless = !process.env.RMF_DASHBOARD_NO_HEADLESS; - const demoPkg = process.env.RMF_DASHBOARD_DEMO_PACKAGE || 'rmf_demos_gz'; + const demoPkg = process.env.RMF_DASHBOARD_DEMO_PACKAGE || 'rmf_demos_ign'; const demoMap = process.env.RMF_DASHBOARD_DEMO_MAP || 'office.launch.xml'; - const demoArgs = ['launch', demoPkg, demoMap]; + const demoArgs = ['launch', demoPkg, demoMap, 'server_uri:=ws://localhost:8001']; if (headless) { demoArgs.push('headless:=true'); } diff --git a/packages/dashboard/src/components/rmf-app/index.tsx b/packages/dashboard/src/components/rmf-app/index.tsx index feb46a71f..da4a5a1c3 100644 --- a/packages/dashboard/src/components/rmf-app/index.tsx +++ b/packages/dashboard/src/components/rmf-app/index.tsx @@ -1,2 +1,3 @@ export * from './contexts'; export * from './rmf-app'; +export * from './rmf-ingress'; diff --git a/packages/dashboard/src/components/robots/robot-page.tsx b/packages/dashboard/src/components/robots/robot-page.tsx index a30c69b47..b7fb48396 100644 --- a/packages/dashboard/src/components/robots/robot-page.tsx +++ b/packages/dashboard/src/components/robots/robot-page.tsx @@ -1,22 +1,24 @@ /* istanbul ignore file */ -import { styled, GridProps, Grid, Card } from '@mui/material'; +import { Box, Card, Grid, GridProps, Paper, styled, Typography } from '@mui/material'; +import { FleetState, RobotState, TaskState } from 'api-client'; +import { AxiosResponse } from 'axios'; import React from 'react'; -import { FleetState } from 'api-client'; -import { MapProps, Map } from 'react-leaflet'; -import { RobotPanel, VerboseRobot } from 'react-components'; +import { RobotInfo, RobotTable, RobotTableData } from 'react-components'; +import { Map, MapProps } from 'react-leaflet'; +import { + useDispenserStatesRef, + useFleets, + useFleetStateRef, + useIngestorStatesRef, +} from '../../util/common-subscriptions'; import { BuildingMapContext, - RmfIngressContext, DispensersContext, IngestorsContext, + RmfIngress, + RmfIngressContext, } from '../rmf-app'; import ScheduleVisualizer from '../schedule-visualizer'; -import { - useFleets, - useFleetStateRef, - useDispenserStatesRef, - useIngestorStatesRef, -} from '../../util/common-subscriptions'; const UpdateRate = 1000; const prefix = 'robot-page'; @@ -24,6 +26,8 @@ const classes = { container: `${prefix}-container`, robotPanel: `${prefix}-robot-panel`, mapPanel: `${prefix}-map-panel`, + detailPanelContainer: `${prefix}-detail-container`, + robotTable: `${prefix}-robot-table`, }; const StyledGrid = styled((props: GridProps) => )(({ theme }) => ({ [`&.${classes.container}`]: { @@ -36,17 +40,78 @@ const StyledGrid = styled((props: GridProps) => )(({ theme }) }, [`& .${classes.mapPanel}`]: { height: '100%', - marginRight: theme.spacing(2), flex: '1 0 auto', }, + [`& .${classes.detailPanelContainer}`]: { + padding: theme.spacing(2), + boxSizing: 'border-box', + height: '100%', + }, + [`& .${classes.robotTable}`]: { + height: '100%', + display: 'flex', + flexDirection: 'column', + }, })); +async function fetchActiveTaskStates(fleets: FleetState[], rmfIngress: RmfIngress) { + const taskIds = fleets.flatMap( + (fleet) => fleet.robots && Object.values(fleet.robots).map((robot) => robot.task_id), + ); + const promises: Promise>[] = []; + for (const taskId of taskIds) { + if (taskId) { + promises.push(rmfIngress.tasksApi.getTaskStateTasksTaskIdStateGet(taskId)); + } + } + const results = await Promise.all(promises); + return results.reduce>((acc, result) => { + acc[result.data.booking.id] = result.data; + return acc; + }, {}); +} + +function getTaskProgress(robot: RobotState, task?: TaskState) { + if ( + !robot.task_id || + !robot.unix_millis_time || + !task || + !task.unix_millis_start_time || + !task.estimate_millis + ) { + return undefined; + } + return Math.min( + (robot.unix_millis_time - task.unix_millis_start_time) / + (task.estimate_millis - task.unix_millis_start_time), + 1, + ); +} + +function NoSelectedRobot() { + return ( + + + Click on a robot to view more information + + + ); +} + export function RobotPage() { const rmfIngress = React.useContext(RmfIngressContext); const sioClient = React.useContext(RmfIngressContext)?.sioClient; - const taskApi = rmfIngress?.tasksApi; const buildingMap = React.useContext(BuildingMapContext); const [leafletMap, setLeafletMap] = React.useState>(); + // FIXME: RobotTable does not know about which fleet a robot belongs to, so there is no way to + // distinguish between robots with the same name in different fleets, events fired by RobotTable, + // will be broken in that case. + const robotStatesRef = React.useRef>({}); + const taskStatesRef = React.useRef>({}); + const [robotTableData, setRobotTableData] = React.useState([]); + const [selectedRobot, setSelectedRobot] = React.useState(undefined); + const [selectedTask, setSelectedTask] = React.useState(undefined); + const [page, setPage] = React.useState(0); const [_triggerRender, setTriggerRender] = React.useState(0); // eslint-disable-line @typescript-eslint/no-unused-vars React.useEffect(() => { @@ -66,53 +131,59 @@ export function RobotPage() { useFleets(rmfIngress, setFleets); const fleetStatesRef = useFleetStateRef(sioClient, fleets); - // robot panel stuff - const [hasMore, setHasMore] = React.useState(true); - const [page, setPage] = React.useState(0); - const [verboseRobots, setVerboseRobots] = React.useState([]); - - const fetchSelectedTask = React.useCallback( - async (taskId: string) => { - if (!taskApi) return; - const resp = await taskApi.getTaskStateTasksTaskIdStateGet(taskId); - return resp.data; - }, - [taskApi], - ); - - const fetchVerboseRobots = React.useCallback(async () => { + // fetch data + React.useEffect(() => { if (!rmfIngress) { - setHasMore(false); - return []; + return; } - const resp = await rmfIngress.fleetsApi.getFleetsFleetsGet(); - let verboseRobots: VerboseRobot[] = []; - resp.data?.forEach((fleet) => { - const robotKey = fleet.robots && Object.keys(fleet.robots); - robotKey?.forEach(async (key) => { - if (fleet.robots) { - let robot = fleet.robots[key]; - if (robot.task_id) { - let task = await fetchSelectedTask(robot.task_id); - verboseRobots.push({ state: fleet.robots[key], current_task_state: task }); - } else { - verboseRobots.push({ state: fleet.robots[key] }); - } + (async () => { + const fleets = (await rmfIngress.fleetsApi.getFleetsFleetsGet()).data; + const tasks = await fetchActiveTaskStates(fleets, rmfIngress); + const newRobotTableData: RobotTableData[] = []; + const newRobotStates: Record = {}; + fleets.forEach((fleet) => { + if (!fleet.robots) { + return; } + Object.values(fleet.robots).forEach((robot) => { + if (!robot.name) { + return; + } + const activeTask = + robot.task_id != null && tasks[robot.task_id] ? tasks[robot.task_id] : undefined; + newRobotTableData.push({ + name: robot.name, + battery: robot.battery, + status: robot.status, + estFinishTime: activeTask && activeTask.estimate_millis, + }); + newRobotStates[robot.name] = robot; + robotStatesRef.current[robot.name] = robot; + }); }); - }); + setRobotTableData(newRobotTableData); + taskStatesRef.current = tasks; + })(); + }, [rmfIngress]); - setVerboseRobots(verboseRobots); - return resp.data; - }, [rmfIngress, fetchSelectedTask]); + const handleRobotClick = async ( + _ev: React.MouseEvent, + robotName: string, + ) => { + const robot = robotStatesRef.current[robotName]; + console.log(robotName, robot); + if (!robot) { + return; + } + setSelectedRobot(robot); + if (robot.task_id) { + setSelectedTask(taskStatesRef.current[robot.task_id]); + } - const onRobotZoom = (robot: VerboseRobot) => { + // zoom to robot leafletMap && leafletMap.leafletElement.setView( - [ - robot.state.location ? robot.state.location.y : 0.0, - robot.state.location ? robot.state.location.x : 0.0, - ], + [robot.location ? robot.location.y : 0.0, robot.location ? robot.location.x : 0.0], 5.5, { animate: true, @@ -120,12 +191,8 @@ export function RobotPage() { ); }; - React.useEffect(() => { - fetchVerboseRobots(); - }, [fetchVerboseRobots]); - return ( - + {buildingMap && ( @@ -142,19 +209,35 @@ export function RobotPage() { - setPage(page), rowsPerPage: 10, rowsPerPageOptions: [10], - page, - onPageChange: (_ev, newPage) => setPage(newPage), }} - verboseRobots={verboseRobots} - onRobotZoom={onRobotZoom} + onRobotClick={handleRobotClick} /> + + + {selectedRobot && selectedRobot.name ? ( + + ) : ( + + )} + + ); } diff --git a/packages/react-components/lib/robots/robot-table.tsx b/packages/react-components/lib/robots/robot-table.tsx index 17eb5159c..246844f7c 100644 --- a/packages/react-components/lib/robots/robot-table.tsx +++ b/packages/react-components/lib/robots/robot-table.tsx @@ -1,6 +1,4 @@ -import { Refresh as RefreshIcon } from '@mui/icons-material'; import { - IconButton, Paper, PaperProps, styled, @@ -116,14 +114,12 @@ export interface RobotTableProps extends PaperProps { */ robots: RobotTableData[]; paginationOptions?: PaginationOptions; - onRefreshClick?: React.MouseEventHandler; onRobotClick?(ev: React.MouseEvent, robotName: string): void; } export function RobotTable({ robots, paginationOptions, - onRefreshClick, onRobotClick, ...paperProps }: RobotTableProps): JSX.Element { @@ -133,9 +129,6 @@ export function RobotTable({ Robots - - - From 240b1f98fdc02ad342dbcdcaa50c967a6cf7e41e Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 17 Feb 2022 17:50:07 +0800 Subject: [PATCH 65/79] memomize some components for perf Signed-off-by: Teo Koon Peng --- .../src/components/robots/robot-page.tsx | 4 +++- .../lib/robots/robot-table.tsx | 24 ++++++++++--------- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/packages/dashboard/src/components/robots/robot-page.tsx b/packages/dashboard/src/components/robots/robot-page.tsx index b7fb48396..cf638457a 100644 --- a/packages/dashboard/src/components/robots/robot-page.tsx +++ b/packages/dashboard/src/components/robots/robot-page.tsx @@ -20,6 +20,8 @@ import { } from '../rmf-app'; import ScheduleVisualizer from '../schedule-visualizer'; +const MemoRobotInfo = React.memo(RobotInfo); + const UpdateRate = 1000; const prefix = 'robot-page'; const classes = { @@ -225,7 +227,7 @@ export function RobotPage() { {selectedRobot && selectedRobot.name ? ( - { + const robotStatusClass = getRobotStatusClass(status); - return ( - - {name} - {estFinishTime ? new Date(estFinishTime).toLocaleString() : '-'} - {battery * 100}% - {status} - - ); -} + return ( + + {name} + {estFinishTime ? new Date(estFinishTime).toLocaleString() : '-'} + {battery * 100}% + {status} + + ); + }, +); export type PaginationOptions = Omit< React.ComponentPropsWithoutRef, From d90c3fe0eb4489d81b96722a564d0845ca96bd6c Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Thu, 17 Feb 2022 18:25:06 +0800 Subject: [PATCH 66/79] remove use of common-subscriptions as they are on the chopping block Signed-off-by: Teo Koon Peng --- .../src/components/robots/robot-page.tsx | 43 ++++++++++--------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/packages/dashboard/src/components/robots/robot-page.tsx b/packages/dashboard/src/components/robots/robot-page.tsx index cf638457a..8946585a4 100644 --- a/packages/dashboard/src/components/robots/robot-page.tsx +++ b/packages/dashboard/src/components/robots/robot-page.tsx @@ -1,23 +1,16 @@ /* istanbul ignore file */ import { Box, Card, Grid, GridProps, Paper, styled, Typography } from '@mui/material'; -import { FleetState, RobotState, TaskState } from 'api-client'; +import { Dispenser, FleetState, Ingestor, RobotState, TaskState } from 'api-client'; import { AxiosResponse } from 'axios'; import React from 'react'; -import { RobotInfo, RobotTable, RobotTableData } from 'react-components'; +import { PaginationOptions, RobotInfo, RobotTable, RobotTableData } from 'react-components'; import { Map, MapProps } from 'react-leaflet'; import { useDispenserStatesRef, - useFleets, useFleetStateRef, useIngestorStatesRef, } from '../../util/common-subscriptions'; -import { - BuildingMapContext, - DispensersContext, - IngestorsContext, - RmfIngress, - RmfIngressContext, -} from '../rmf-app'; +import { BuildingMapContext, RmfIngress, RmfIngressContext } from '../rmf-app'; import ScheduleVisualizer from '../schedule-visualizer'; const MemoRobotInfo = React.memo(RobotInfo); @@ -122,15 +115,13 @@ export function RobotPage() { }, []); // get work cells to display on map - const dispensers = React.useContext(DispensersContext); + const [dispensers, setDispensers] = React.useState([]); useDispenserStatesRef(sioClient, dispensers); - - const ingestors = React.useContext(IngestorsContext); + const [ingestors, setIngestors] = React.useState([]); useIngestorStatesRef(sioClient, ingestors); // schedule visualizer fleet const [fleets, setFleets] = React.useState([]); - useFleets(rmfIngress, setFleets); const fleetStatesRef = useFleetStateRef(sioClient, fleets); // fetch data @@ -139,6 +130,8 @@ export function RobotPage() { return; } (async () => { + const dispensers = (await rmfIngress.dispensersApi.getDispensersDispensersGet()).data; + const ingestors = (await rmfIngress.ingestorsApi.getIngestorsIngestorsGet()).data; const fleets = (await rmfIngress.fleetsApi.getFleetsFleetsGet()).data; const tasks = await fetchActiveTaskStates(fleets, rmfIngress); const newRobotTableData: RobotTableData[] = []; @@ -165,6 +158,9 @@ export function RobotPage() { }); setRobotTableData(newRobotTableData); taskStatesRef.current = tasks; + setDispensers(dispensers); + setIngestors(ingestors); + setFleets(fleets); })(); }, [rmfIngress]); @@ -193,6 +189,17 @@ export function RobotPage() { ); }; + const paginationOptions = React.useMemo( + () => ({ + count: robotTableData.length, + page, + onPageChange: (_, page) => setPage(page), + rowsPerPage: 10, + rowsPerPageOptions: [10], + }), + [page, robotTableData.length], + ); + return ( @@ -214,13 +221,7 @@ export function RobotPage() { setPage(page), - rowsPerPage: 10, - rowsPerPageOptions: [10], - }} + paginationOptions={paginationOptions} onRobotClick={handleRobotClick} /> From 60acae8457c87ee8db21dac7d190bf83f0c70f57 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Fri, 18 Feb 2022 11:05:45 +0800 Subject: [PATCH 67/79] add tests Signed-off-by: Teo Koon Peng --- .../lib/robots/robot-info.spec.tsx | 24 +++++++++++++++++++ .../lib/robots/robot-info.tsx | 6 +++-- .../lib/robots/robot-table.spec.tsx | 16 +++++++++++++ .../lib/robots/robot-table.tsx | 1 - 4 files changed, 44 insertions(+), 3 deletions(-) diff --git a/packages/react-components/lib/robots/robot-info.spec.tsx b/packages/react-components/lib/robots/robot-info.spec.tsx index c82c0f755..2bed3fb07 100644 --- a/packages/react-components/lib/robots/robot-info.spec.tsx +++ b/packages/react-components/lib/robots/robot-info.spec.tsx @@ -21,4 +21,28 @@ describe('RobotInfo', () => { expect(() => root.getByText(/.*underway/)).not.toThrow(); expect(() => root.getByText(new Date(0).toLocaleString())).not.toThrow(); }); + + describe('Task status', () => { + it('shows no task when there is no assigned task and task status', () => { + const root = render(); + expect(() => root.getByText(/No Task/)).not.toThrow(); + }); + + it('shows unknown when there is an assigned task but no status', () => { + const root = render( + , + ); + expect(() => root.getByText(/Unknown/)).not.toThrow(); + }); + }); + + it('defaults to 0% when no battery is available', () => { + const root = render(); + expect(() => root.getByText('0%')).not.toThrow(); + }); }); diff --git a/packages/react-components/lib/robots/robot-info.tsx b/packages/react-components/lib/robots/robot-info.tsx index 97be62993..b070ff13a 100644 --- a/packages/react-components/lib/robots/robot-info.tsx +++ b/packages/react-components/lib/robots/robot-info.tsx @@ -1,8 +1,8 @@ import { Button, Divider, Grid, styled, Typography, useTheme } from '@mui/material'; +import type { TaskState } from 'api-client'; import React from 'react'; import { CircularProgressBar } from './circular-progress-bar'; import { LinearProgressBar } from './linear-progress-bar'; -import type { TaskState } from 'api-client'; function getTaskStatusDisplay(assignedTask?: string, taskStatus?: string) { if (assignedTask && !taskStatus) { @@ -38,6 +38,8 @@ export interface RobotInfoProps { estFinishTime?: number; } +const finishedStatus: TaskStatus[] = ['failed', 'completed', 'skipped', 'killed', 'canceled']; + export function RobotInfo({ robotName, battery, @@ -47,7 +49,7 @@ export function RobotInfo({ estFinishTime, }: RobotInfoProps): JSX.Element { const theme = useTheme(); - const [hasConcreteEndTime] = React.useState(false); + const hasConcreteEndTime = taskStatus && taskStatus in finishedStatus; return ( diff --git a/packages/react-components/lib/robots/robot-table.spec.tsx b/packages/react-components/lib/robots/robot-table.spec.tsx index 8e873aebb..0d750edb9 100644 --- a/packages/react-components/lib/robots/robot-table.spec.tsx +++ b/packages/react-components/lib/robots/robot-table.spec.tsx @@ -1,4 +1,5 @@ import { render } from '@testing-library/react'; +import userEvent from '@testing-library/user-event'; import { Status2 as RobotStatus } from 'api-client'; import React from 'react'; import { RobotTable, RobotTableData } from './robot-table'; @@ -45,4 +46,19 @@ describe('RobotTable', () => { // NOTE: mui v5 is using the unicode char '–', different from '-'!! expect(root.queryByText('1–1 of 1')).toBeNull(); }); + + it('onRobotClick is called when row is clicked', () => { + const onRobotClick = jasmine.createSpy(); + const root = render( + , + ); + const robot = root.getByText('test_robot'); + userEvent.click(robot); + expect(onRobotClick).toHaveBeenCalledWith(jasmine.anything(), 'test_robot'); + }); + + it('finish time is shown when it is available', () => { + const root = render(); + expect(() => root.getByText(new Date(1000).toLocaleString())).not.toThrow(); + }); }); diff --git a/packages/react-components/lib/robots/robot-table.tsx b/packages/react-components/lib/robots/robot-table.tsx index 39238cfe0..ed6c1a93f 100644 --- a/packages/react-components/lib/robots/robot-table.tsx +++ b/packages/react-components/lib/robots/robot-table.tsx @@ -86,7 +86,6 @@ function getRobotStatusClass(robotStatus?: RobotStatus) { case 'uninitialized': return classes.robotStoppedClass; } - return ''; } const RobotRow = React.memo( From 310b8338c5f929cb0dd099cce5d0cb4835245794 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Fri, 18 Feb 2022 11:39:03 +0800 Subject: [PATCH 68/79] update puppeteer Signed-off-by: Teo Koon Peng --- package-lock.json | 237 ++++++++++++++----------- packages/react-components/package.json | 2 +- 2 files changed, 131 insertions(+), 108 deletions(-) diff --git a/package-lock.json b/package-lock.json index 2ae115305..7cd7b207e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -17011,6 +17011,15 @@ "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", "dev": true }, + "node_modules/cross-fetch": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.1.5.tgz", + "integrity": "sha512-lvb1SBsI0Z7GDwmuid+mU3kWVBwTVUbe7S0H52yaaAdQOXq2YktTCZdlAcNKFzE6QtRz0snpw9bNiPeOIkkQvw==", + "dev": true, + "dependencies": { + "node-fetch": "2.6.7" + } + }, "node_modules/cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", @@ -27377,6 +27386,12 @@ "node": ">=10" } }, + "node_modules/mkdirp-classic": { + "version": "0.5.3", + "resolved": "https://registry.npmjs.org/mkdirp-classic/-/mkdirp-classic-0.5.3.tgz", + "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==", + "dev": true + }, "node_modules/mocha": { "version": "9.1.3", "resolved": "https://registry.npmjs.org/mocha/-/mocha-9.1.3.tgz", @@ -27749,15 +27764,23 @@ } }, "node_modules/node-fetch": { - "version": "2.6.6", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.6.tgz", - "integrity": "sha512-Z8/6vRlTUChSdIgMa51jxQ4lrw/Jy5SOW10ObaA47/RElsAN2c5Pn8bTgFGWn/ibwzXTE8qwr1Yzx28vsecXEA==", + "version": "2.6.7", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", + "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==", "dev": true, "dependencies": { "whatwg-url": "^5.0.0" }, "engines": { "node": "4.x || >=6.0.0" + }, + "peerDependencies": { + "encoding": "^0.1.0" + }, + "peerDependenciesMeta": { + "encoding": { + "optional": true + } } }, "node_modules/node-fetch/node_modules/tr46": { @@ -30893,24 +30916,24 @@ "dev": true }, "node_modules/puppeteer": { - "version": "10.4.0", - "resolved": "https://registry.npmjs.org/puppeteer/-/puppeteer-10.4.0.tgz", - "integrity": "sha512-2cP8mBoqnu5gzAVpbZ0fRaobBWZM8GEUF4I1F6WbgHrKV/rz7SX8PG2wMymZgD0wo0UBlg2FBPNxlF/xlqW6+w==", + "version": "13.3.2", + "resolved": "https://registry.npmjs.org/puppeteer/-/puppeteer-13.3.2.tgz", + "integrity": "sha512-TIt8/R0eaUwY1c0/O0sCJpSglvGEWVoWFfGZ2dNtxX3eHuBo1ln9abaWfxTjZfsrkYATLSs8oqEdRZpMNnCsvg==", "dev": true, "hasInstallScript": true, "dependencies": { - "debug": "4.3.1", - "devtools-protocol": "0.0.901419", + "cross-fetch": "3.1.5", + "debug": "4.3.3", + "devtools-protocol": "0.0.960912", "extract-zip": "2.0.1", "https-proxy-agent": "5.0.0", - "node-fetch": "2.6.1", "pkg-dir": "4.2.0", - "progress": "2.0.1", + "progress": "2.0.3", "proxy-from-env": "1.1.0", "rimraf": "3.0.2", - "tar-fs": "2.0.0", - "unbzip2-stream": "1.3.3", - "ws": "7.4.6" + "tar-fs": "2.1.1", + "unbzip2-stream": "1.4.3", + "ws": "8.5.0" }, "engines": { "node": ">=10.18.1" @@ -31096,22 +31119,17 @@ "node": ">= 6.0.0" } }, - "node_modules/puppeteer/node_modules/debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "dependencies": { - "ms": "2.1.2" - }, - "engines": { - "node": ">=6.0" - }, - "peerDependenciesMeta": { - "supports-color": { - "optional": true - } - } + "node_modules/puppeteer/node_modules/chownr": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-1.1.4.tgz", + "integrity": "sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==", + "dev": true + }, + "node_modules/puppeteer/node_modules/devtools-protocol": { + "version": "0.0.960912", + "resolved": "https://registry.npmjs.org/devtools-protocol/-/devtools-protocol-0.0.960912.tgz", + "integrity": "sha512-I3hWmV9rWHbdnUdmMKHF2NuYutIM2kXz2mdXW8ha7TbRlGTVs+PF+PsB5QWvpCek4Fy9B+msiispCfwlhG5Sqg==", + "dev": true }, "node_modules/puppeteer/node_modules/find-up": { "version": "4.1.0", @@ -31151,15 +31169,6 @@ "node": ">=8" } }, - "node_modules/puppeteer/node_modules/node-fetch": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz", - "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==", - "dev": true, - "engines": { - "node": "4.x || >=6.0.0" - } - }, "node_modules/puppeteer/node_modules/p-limit": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", @@ -31199,34 +31208,26 @@ "node": ">=8" } }, - "node_modules/puppeteer/node_modules/progress": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.1.tgz", - "integrity": "sha512-OE+a6vzqazc+K6LxJrX5UPyKFvGnL5CYmq2jFGNIBWHpc4QyE49/YOumcrpQFJpfejmvRtbJzgO1zPmMCqlbBg==", + "node_modules/puppeteer/node_modules/tar-fs": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.1.tgz", + "integrity": "sha512-V0r2Y9scmbDRLCNex/+hYzvp/zyYjvFbHPNgVTKfQvVrb6guiE/fxP+XblDNR011utopbkex2nM4dHNV6GDsng==", "dev": true, - "engines": { - "node": ">=0.4.0" + "dependencies": { + "chownr": "^1.1.1", + "mkdirp-classic": "^0.5.2", + "pump": "^3.0.0", + "tar-stream": "^2.1.4" } }, - "node_modules/puppeteer/node_modules/ws": { - "version": "7.4.6", - "resolved": "https://registry.npmjs.org/ws/-/ws-7.4.6.tgz", - "integrity": "sha512-YmhHDO4MzaDLB+M9ym/mDA5z0naX8j7SIlT8f8z+I0VtzsRbekxEutHSme7NPS2qE8StCYQNUnfWdXta/Yu85A==", + "node_modules/puppeteer/node_modules/unbzip2-stream": { + "version": "1.4.3", + "resolved": "https://registry.npmjs.org/unbzip2-stream/-/unbzip2-stream-1.4.3.tgz", + "integrity": "sha512-mlExGW4w71ebDJviH16lQLtZS32VKqsSfk80GCfUlwT/4/hNRFsoscrF/c++9xinkMzECL1uL9DDwXqFWkruPg==", "dev": true, - "engines": { - "node": ">=8.3.0" - }, - "peerDependencies": { - "bufferutil": "^4.0.1", - "utf-8-validate": "^5.0.2" - }, - "peerDependenciesMeta": { - "bufferutil": { - "optional": true - }, - "utf-8-validate": { - "optional": true - } + "dependencies": { + "buffer": "^5.2.1", + "through": "^2.3.8" } }, "node_modules/pyright": { @@ -41727,9 +41728,9 @@ } }, "node_modules/ws": { - "version": "8.4.2", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.4.2.tgz", - "integrity": "sha512-Kbk4Nxyq7/ZWqr/tarI9yIt/+iNNFOjBXEWgTb4ydaNHBNGgvf2QHbS9fdfsndfjFlFwEd4Al+mw83YkaD10ZA==", + "version": "8.5.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.5.0.tgz", + "integrity": "sha512-BWX0SWVgLPzYwF8lTzEy1egjhS4S4OEAHfsO8o65WOVsrnSRGaSiUaa9e0ggGlkMTtBlmOpEXiie9RUcBO86qg==", "dev": true, "engines": { "node": ">=10.0.0" @@ -42227,7 +42228,7 @@ "karma-webpack": "^4.0.2", "leaflet": "^1.7.1", "process": "0.11.10", - "puppeteer": "^10.2.0", + "puppeteer": "*", "react": "^17.0.2", "react-dom": "^17.0.2", "react-leaflet": "^2.7.0", @@ -55479,6 +55480,15 @@ "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", "dev": true }, + "cross-fetch": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/cross-fetch/-/cross-fetch-3.1.5.tgz", + "integrity": "sha512-lvb1SBsI0Z7GDwmuid+mU3kWVBwTVUbe7S0H52yaaAdQOXq2YktTCZdlAcNKFzE6QtRz0snpw9bNiPeOIkkQvw==", + "dev": true, + "requires": { + "node-fetch": "2.6.7" + } + }, "cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", @@ -63683,6 +63693,12 @@ "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", "dev": true }, + "mkdirp-classic": { + "version": "0.5.3", + "resolved": "https://registry.npmjs.org/mkdirp-classic/-/mkdirp-classic-0.5.3.tgz", + "integrity": "sha512-gKLcREMhtuZRwRAfqP3RFW+TK4JqApVBtOIftVgjuABpAtpxhPGaDcfvbhNvD0B8iD1oUr/txX35NjcaY6Ns/A==", + "dev": true + }, "mocha": { "version": "9.1.3", "resolved": "https://registry.npmjs.org/mocha/-/mocha-9.1.3.tgz", @@ -63988,9 +64004,9 @@ } }, "node-fetch": { - "version": "2.6.6", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.6.tgz", - "integrity": "sha512-Z8/6vRlTUChSdIgMa51jxQ4lrw/Jy5SOW10ObaA47/RElsAN2c5Pn8bTgFGWn/ibwzXTE8qwr1Yzx28vsecXEA==", + "version": "2.6.7", + "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz", + "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==", "dev": true, "requires": { "whatwg-url": "^5.0.0" @@ -66545,23 +66561,23 @@ "dev": true }, "puppeteer": { - "version": "10.4.0", - "resolved": "https://registry.npmjs.org/puppeteer/-/puppeteer-10.4.0.tgz", - "integrity": "sha512-2cP8mBoqnu5gzAVpbZ0fRaobBWZM8GEUF4I1F6WbgHrKV/rz7SX8PG2wMymZgD0wo0UBlg2FBPNxlF/xlqW6+w==", + "version": "13.3.2", + "resolved": "https://registry.npmjs.org/puppeteer/-/puppeteer-13.3.2.tgz", + "integrity": "sha512-TIt8/R0eaUwY1c0/O0sCJpSglvGEWVoWFfGZ2dNtxX3eHuBo1ln9abaWfxTjZfsrkYATLSs8oqEdRZpMNnCsvg==", "dev": true, "requires": { - "debug": "4.3.1", - "devtools-protocol": "0.0.901419", + "cross-fetch": "3.1.5", + "debug": "4.3.3", + "devtools-protocol": "0.0.960912", "extract-zip": "2.0.1", "https-proxy-agent": "5.0.0", - "node-fetch": "2.6.1", "pkg-dir": "4.2.0", - "progress": "2.0.1", + "progress": "2.0.3", "proxy-from-env": "1.1.0", "rimraf": "3.0.2", - "tar-fs": "2.0.0", - "unbzip2-stream": "1.3.3", - "ws": "7.4.6" + "tar-fs": "2.1.1", + "unbzip2-stream": "1.4.3", + "ws": "8.5.0" }, "dependencies": { "agent-base": { @@ -66573,14 +66589,17 @@ "debug": "4" } }, - "debug": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz", - "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==", - "dev": true, - "requires": { - "ms": "2.1.2" - } + "chownr": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/chownr/-/chownr-1.1.4.tgz", + "integrity": "sha512-jJ0bqzaylmJtVnNgzTeSOs8DPavpbYgEr/b0YL8/2GO3xJEhInFmhKMUnEJQjZumK7KXGFhUy89PrsJWlakBVg==", + "dev": true + }, + "devtools-protocol": { + "version": "0.0.960912", + "resolved": "https://registry.npmjs.org/devtools-protocol/-/devtools-protocol-0.0.960912.tgz", + "integrity": "sha512-I3hWmV9rWHbdnUdmMKHF2NuYutIM2kXz2mdXW8ha7TbRlGTVs+PF+PsB5QWvpCek4Fy9B+msiispCfwlhG5Sqg==", + "dev": true }, "find-up": { "version": "4.1.0", @@ -66611,12 +66630,6 @@ "p-locate": "^4.1.0" } }, - "node-fetch": { - "version": "2.6.1", - "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.1.tgz", - "integrity": "sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==", - "dev": true - }, "p-limit": { "version": "2.3.0", "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz", @@ -66644,17 +66657,27 @@ "find-up": "^4.0.0" } }, - "progress": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.1.tgz", - "integrity": "sha512-OE+a6vzqazc+K6LxJrX5UPyKFvGnL5CYmq2jFGNIBWHpc4QyE49/YOumcrpQFJpfejmvRtbJzgO1zPmMCqlbBg==", - "dev": true + "tar-fs": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/tar-fs/-/tar-fs-2.1.1.tgz", + "integrity": "sha512-V0r2Y9scmbDRLCNex/+hYzvp/zyYjvFbHPNgVTKfQvVrb6guiE/fxP+XblDNR011utopbkex2nM4dHNV6GDsng==", + "dev": true, + "requires": { + "chownr": "^1.1.1", + "mkdirp-classic": "^0.5.2", + "pump": "^3.0.0", + "tar-stream": "^2.1.4" + } }, - "ws": { - "version": "7.4.6", - "resolved": "https://registry.npmjs.org/ws/-/ws-7.4.6.tgz", - "integrity": "sha512-YmhHDO4MzaDLB+M9ym/mDA5z0naX8j7SIlT8f8z+I0VtzsRbekxEutHSme7NPS2qE8StCYQNUnfWdXta/Yu85A==", - "dev": true + "unbzip2-stream": { + "version": "1.4.3", + "resolved": "https://registry.npmjs.org/unbzip2-stream/-/unbzip2-stream-1.4.3.tgz", + "integrity": "sha512-mlExGW4w71ebDJviH16lQLtZS32VKqsSfk80GCfUlwT/4/hNRFsoscrF/c++9xinkMzECL1uL9DDwXqFWkruPg==", + "dev": true, + "requires": { + "buffer": "^5.2.1", + "through": "^2.3.8" + } } } }, @@ -67055,7 +67078,7 @@ "leaflet": "^1.7.1", "node-vibrant": "^3.1.6", "process": "0.11.10", - "puppeteer": "^10.2.0", + "puppeteer": "*", "rbush": "^3.0.1", "react": "^17.0.2", "react-customizable-progressbar": "^1.0.3", @@ -75448,9 +75471,9 @@ } }, "ws": { - "version": "8.4.2", - "resolved": "https://registry.npmjs.org/ws/-/ws-8.4.2.tgz", - "integrity": "sha512-Kbk4Nxyq7/ZWqr/tarI9yIt/+iNNFOjBXEWgTb4ydaNHBNGgvf2QHbS9fdfsndfjFlFwEd4Al+mw83YkaD10ZA==", + "version": "8.5.0", + "resolved": "https://registry.npmjs.org/ws/-/ws-8.5.0.tgz", + "integrity": "sha512-BWX0SWVgLPzYwF8lTzEy1egjhS4S4OEAHfsO8o65WOVsrnSRGaSiUaa9e0ggGlkMTtBlmOpEXiie9RUcBO86qg==", "dev": true }, "xhr": { diff --git a/packages/react-components/package.json b/packages/react-components/package.json index 7ed5e876d..d0a0d00a9 100644 --- a/packages/react-components/package.json +++ b/packages/react-components/package.json @@ -80,7 +80,7 @@ "karma-webpack": "^4.0.2", "leaflet": "^1.7.1", "process": "0.11.10", - "puppeteer": "^10.2.0", + "puppeteer": "*", "react": "^17.0.2", "react-dom": "^17.0.2", "react-leaflet": "^2.7.0", From f7699c781398bbf765db5ee28136e74aadaa490d Mon Sep 17 00:00:00 2001 From: Mohamad Date: Sun, 20 Feb 2022 18:37:45 +0100 Subject: [PATCH 69/79] fix auto refresh in task page Signed-off-by: Mohamad --- packages/dashboard/src/components/tasks/task-page.tsx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/packages/dashboard/src/components/tasks/task-page.tsx b/packages/dashboard/src/components/tasks/task-page.tsx index b201ee405..6aca98f46 100644 --- a/packages/dashboard/src/components/tasks/task-page.tsx +++ b/packages/dashboard/src/components/tasks/task-page.tsx @@ -18,6 +18,7 @@ const StyledTaskPage = styled((props: TaskPanelProps) => ([]); const [updatedSummaries, setUpdatedStates] = React.useState>({}); @@ -53,6 +54,13 @@ export function TaskPage() { [tasksApi], ); + React.useEffect(() => { + const interval = setInterval(() => { + if (autoRefreshEnabled) handleRefresh(); + }, RefreshRate); + return () => clearInterval(interval); + }, [sioClient, autoRefreshEnabled]); + React.useEffect(() => { if (!autoRefreshEnabled || !sioClient) return; const subs = fetchedTasks.map((t) => From aca190e0f694d6ee31aaf7aaa49e7594ae70a044 Mon Sep 17 00:00:00 2001 From: Mohamad Date: Sun, 20 Feb 2022 19:06:06 +0100 Subject: [PATCH 70/79] add auto refresh to tasks panel and tasks components Signed-off-by: Mohamad --- packages/dashboard/src/components/tasks/task-panel.tsx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/packages/dashboard/src/components/tasks/task-panel.tsx b/packages/dashboard/src/components/tasks/task-panel.tsx index c750603b7..29f69e79a 100644 --- a/packages/dashboard/src/components/tasks/task-panel.tsx +++ b/packages/dashboard/src/components/tasks/task-panel.tsx @@ -125,6 +125,7 @@ export function TaskPanel({ onAutoRefresh, ...divProps }: TaskPanelProps): JSX.Element { + const RefreshRate = 5000; const theme = useTheme(); const [selectedTask, setSelectedTask] = React.useState(undefined); const [selectedTaskState, setSelectedTaskState] = React.useState( @@ -204,6 +205,13 @@ export function TaskPanel({ } }, [tasksApi, selectedTask]); + React.useEffect(() => { + const interval = setInterval(() => { + if (autoRefresh) fetchLogs(); + }, RefreshRate); + return () => clearInterval(interval); + }, [tasksApi, selectedTask, onAutoRefresh]); + React.useEffect(() => { fetchLogs(); }, [selectedTask, fetchLogs]); From 5eb0ffc585540492c5cce02575a4ad59ead19f67 Mon Sep 17 00:00:00 2001 From: Mohamad Date: Sun, 20 Feb 2022 20:49:07 +0100 Subject: [PATCH 71/79] fix missing dep in useEffect Signed-off-by: Mohamad --- .../dashboard/src/components/tasks/task-page.tsx | 14 +++++++------- .../dashboard/src/components/tasks/task-panel.tsx | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/packages/dashboard/src/components/tasks/task-page.tsx b/packages/dashboard/src/components/tasks/task-page.tsx index 6aca98f46..5b36b7db8 100644 --- a/packages/dashboard/src/components/tasks/task-page.tsx +++ b/packages/dashboard/src/components/tasks/task-page.tsx @@ -54,13 +54,6 @@ export function TaskPage() { [tasksApi], ); - React.useEffect(() => { - const interval = setInterval(() => { - if (autoRefreshEnabled) handleRefresh(); - }, RefreshRate); - return () => clearInterval(interval); - }, [sioClient, autoRefreshEnabled]); - React.useEffect(() => { if (!autoRefreshEnabled || !sioClient) return; const subs = fetchedTasks.map((t) => @@ -84,6 +77,13 @@ export function TaskPage() { handleRefresh(); }, [handleRefresh]); + React.useEffect(() => { + const interval = setInterval(() => { + if (autoRefreshEnabled) handleRefresh(); + }, RefreshRate); + return () => clearInterval(interval); + }, [handleRefresh, sioClient, autoRefreshEnabled]); + const submitTasks = React.useCallback['submitTasks']>( async (taskRequests) => { if (!tasksApi) { diff --git a/packages/dashboard/src/components/tasks/task-panel.tsx b/packages/dashboard/src/components/tasks/task-panel.tsx index 29f69e79a..564294c90 100644 --- a/packages/dashboard/src/components/tasks/task-panel.tsx +++ b/packages/dashboard/src/components/tasks/task-panel.tsx @@ -210,7 +210,7 @@ export function TaskPanel({ if (autoRefresh) fetchLogs(); }, RefreshRate); return () => clearInterval(interval); - }, [tasksApi, selectedTask, onAutoRefresh]); + }, [tasksApi, selectedTask, autoRefresh]); React.useEffect(() => { fetchLogs(); From 8da47da00ff526108bb1637c2e4451729d865f78 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 21 Feb 2022 13:25:07 +0800 Subject: [PATCH 72/79] update task logs in react-components Signed-off-by: Teo Koon Peng --- packages/react-components/lib/tasks/index.ts | 1 + .../lib/tasks/task-logs.spec.tsx | 84 ++++++-- .../lib/tasks/task-logs.stories.tsx | 18 +- .../react-components/lib/tasks/task-logs.tsx | 204 +++++++++--------- .../lib/tasks/task-table.spec.tsx | 8 + .../lib/tasks/test-data.spec.ts | 2 +- 6 files changed, 184 insertions(+), 133 deletions(-) diff --git a/packages/react-components/lib/tasks/index.ts b/packages/react-components/lib/tasks/index.ts index 65ea42778..d12163f8c 100644 --- a/packages/react-components/lib/tasks/index.ts +++ b/packages/react-components/lib/tasks/index.ts @@ -1,4 +1,5 @@ export * from './create-task'; export * from './task-info'; +export * from './task-logs'; export * from './task-table'; export * from './task-timeline'; diff --git a/packages/react-components/lib/tasks/task-logs.spec.tsx b/packages/react-components/lib/tasks/task-logs.spec.tsx index 3687afa5e..bb9ec53c8 100644 --- a/packages/react-components/lib/tasks/task-logs.spec.tsx +++ b/packages/react-components/lib/tasks/task-logs.spec.tsx @@ -1,18 +1,74 @@ -//import { render } from '@testing-library/react'; -//import React from 'react'; -//import { TaskLogs } from './task-logs'; -//import { makeTaskLog } from './test-data.spec'; +import { render } from '@testing-library/react'; +import React from 'react'; +import { TaskLogs } from './task-logs'; +import { makeTaskLog } from './test-data.spec'; -describe('TaskLogs', () => { +fdescribe('TaskLogs', () => { it('shows all event logs', () => { - //const logs = makeTaskLog('task'); - //const root = render(); - //Object.values(logs.phases).forEach((p) => { - //Object.values(p.events).forEach((e) => { - //e.forEach((l) => { - //expect(root.getAllByText(l.text).length).toBeGreaterThan(0); - //}); - //}); - //}); + const logs = makeTaskLog('task'); + const root = render( + `Event ${eventId}`} + eventStatus={() => 'completed'} + />, + ); + Object.values(logs.phases).forEach((p) => { + Object.values(p.events).forEach((e) => { + e.forEach((l) => { + expect(root.getAllByText(l.text).length).toBeGreaterThan(0); + }); + }); + }); + }); + + it('placeholder is shown when an event has no logs', () => { + const root = render( + 'test_event'} + eventStatus={() => 'completed'} + />, + ); + expect(() => root.getByText('No Logs')).not.toThrow(); + }); + + it('placeholder is shown when there are no events', () => { + const root = render( + 'test_event'} + eventStatus={() => 'completed'} + />, + ); + expect(() => root.getByText('No Event Logs')).not.toThrow(); + }); + + it('placeholder is shown where there are no phases', () => { + const root = render( + 'test_event'} + eventStatus={() => 'completed'} + />, + ); + expect(() => root.getByText('No logs to be shown')).not.toThrow(); }); }); diff --git a/packages/react-components/lib/tasks/task-logs.stories.tsx b/packages/react-components/lib/tasks/task-logs.stories.tsx index e29d257e5..2f9306de4 100644 --- a/packages/react-components/lib/tasks/task-logs.stories.tsx +++ b/packages/react-components/lib/tasks/task-logs.stories.tsx @@ -6,24 +6,16 @@ import { makeTaskLog } from './test-data.spec'; export default { title: 'Tasks/Logs', component: TaskLogs, - argTypes: { - paginationOptions: { - control: { - disable: true, - }, - }, - submitTask: { - control: { - disable: true, - }, - }, - }, } as Meta; export const Logs: Story = (args) => { return ; }; +const taskLog = makeTaskLog('task'); + Logs.args = { - taskLog: makeTaskLog('task'), + taskLog, + eventName: (_phaseId, eventId) => `Event ${eventId}`, + eventStatus: () => 'completed', }; diff --git a/packages/react-components/lib/tasks/task-logs.tsx b/packages/react-components/lib/tasks/task-logs.tsx index b37580b82..054c0700d 100644 --- a/packages/react-components/lib/tasks/task-logs.tsx +++ b/packages/react-components/lib/tasks/task-logs.tsx @@ -1,62 +1,63 @@ -import React from 'react'; import { Divider, Grid, Paper, PaperProps, styled, Typography, useTheme } from '@mui/material'; -import { TaskEventLog, TaskState, EventState, Status } from 'api-client'; -import { format } from 'date-fns'; +import type { EventState, TaskEventLog } from 'api-client'; +import React from 'react'; + +type EventStatus = Required['status']; + const prefix = 'task-logs'; const classes = { root: `${prefix}-root`, }; -export interface TaskLogProps { +export interface TaskLogsProps { taskLog: TaskEventLog; - taskState: TaskState; - fetchTaskLogs?: () => Promise; + eventName: (phaseId: string, eventId: string) => string; + eventStatus: (phaseId: string, eventId: string) => EventStatus | undefined; } const StyledPaper = styled((props: PaperProps) => )( ({ theme }) => ({ [`&.${classes.root}`]: { padding: theme.spacing(1), - width: '95%', + width: '100%', flex: '0 0 auto', - maxHeight: '95%', + maxHeight: '100%', overflow: 'auto', }, }), ); -export function TaskLogs({ taskLog, taskState }: TaskLogProps) { +export const TaskLogs: React.FC = ({ taskLog, eventName, eventStatus }) => { const theme = useTheme(); - const phaseIds = taskLog.phases ? Object.keys(taskLog.phases) : []; - function mapEventColor(event: EventState | null) { + function mapEventColor(eventStatus?: EventStatus) { // TODO(MXG): We should make this color selection consistent with the color // selection that's done for task states. - if (event == null || event.status == null) return theme.palette.warning.light; + if (eventStatus == null) return theme.palette.warning.light; - switch (event.status) { - case Status.Uninitialized: - case Status.Blocked: - case Status.Error: - case Status.Failed: + switch (eventStatus) { + case 'uninitialized': + case 'blocked': + case 'error': + case 'failed': return theme.palette.error.dark; - case Status.Queued: - case Status.Standby: + case 'queued': + case 'standby': return theme.palette.info.light; - case Status.Underway: + case 'underway': return theme.palette.success.light; - case Status.Delayed: + case 'delayed': return theme.palette.warning.main; - case Status.Skipped: - case Status.Canceled: - case Status.Killed: + case 'skipped': + case 'canceled': + case 'killed': return theme.palette.error.light; - case Status.Completed: + case 'completed': return theme.palette.info.light; default: @@ -70,97 +71,90 @@ export function TaskLogs({ taskLog, taskState }: TaskLogProps) { {taskLog.task_id} - {phaseIds.length > 0 ? ( - phaseIds.map((id: string) => { - const getEventObj: any = taskLog.phases ? taskLog.phases[id] : null; - const events = getEventObj ? getEventObj['events'] : {}; - const eventIds = events ? Object.keys(events) : []; - const phaseStateObj = taskState.phases ? taskState.phases[id] : null; - const eventStates = phaseStateObj ? phaseStateObj.events : {}; + {taskLog.phases ? ( + Object.entries(taskLog.phases).map(([phaseId, phase]) => ( + + + Phase - {phaseId} + - return ( - - - {phaseStateObj && phaseStateObj.id ? phaseStateObj.id.toString() : 'unknown #'}.{' '} - {phaseStateObj && phaseStateObj.category ? phaseStateObj.category : 'undefined'} - - - - {eventIds.length > 0 ? ( - eventIds.map((idx) => { - const event = events[idx]; - const eventState = eventStates ? eventStates[idx] : null; - return ( -
- - {eventState?.name} - - {event.map((e: any, i: any) => { - return ( + + {phase.events ? ( + Object.entries(phase.events).map(([eventId, event]) => { + return ( +
+ + {eventName(phaseId, eventId)} + + {event.length > 0 ? ( + event.map((log, idx) => ( + + + + {new Date(log.unix_millis_time).toLocaleString()} + + - - - {format(new Date(e.unix_millis_time), "hh:mm:ss aaaaa'm'")} - - - - {e.text} - + {log.text} - ); - })} -
- ); - }) - ) : ( - - No Event Logs - - )} - - ); - }) + + )) + ) : ( + + No Logs + + )} +
+ ); + }) + ) : ( + + No Event Logs + + )} + + )) ) : (
- No Logs to be shown + No logs to be shown
)} ); -} +}; diff --git a/packages/react-components/lib/tasks/task-table.spec.tsx b/packages/react-components/lib/tasks/task-table.spec.tsx index 3d586701f..c6fbdc28e 100644 --- a/packages/react-components/lib/tasks/task-table.spec.tsx +++ b/packages/react-components/lib/tasks/task-table.spec.tsx @@ -1,4 +1,5 @@ import { render } from '@testing-library/react'; +import userEvent from '@testing-library/user-event'; import React from 'react'; import { TaskTable } from './task-table'; import { makeTaskState } from './test-data.spec'; @@ -10,4 +11,11 @@ describe('TaskTable', () => { root.getByText('task_0'); root.getByText('task_1'); }); + + it('onTaskClick is called when task is clicked', () => { + const tasks = [makeTaskState('task_0')]; + const root = render(); + const elem = root.getByText('task_0'); + userEvent.click(elem); + }); }); diff --git a/packages/react-components/lib/tasks/test-data.spec.ts b/packages/react-components/lib/tasks/test-data.spec.ts index b0e638872..52eb39724 100644 --- a/packages/react-components/lib/tasks/test-data.spec.ts +++ b/packages/react-components/lib/tasks/test-data.spec.ts @@ -1,4 +1,4 @@ -import type { TaskEventLog, TaskState, TaskRequest } from 'api-client'; +import type { TaskEventLog, TaskRequest, TaskState } from 'api-client'; export function makeTaskState(taskId: string): TaskState { const state = JSON.parse(`{ From 9cc9e305aa6c598885cb3ce0dab5a6bca1ae1c8d Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 21 Feb 2022 13:27:40 +0800 Subject: [PATCH 73/79] update tests Signed-off-by: Teo Koon Peng --- packages/react-components/lib/tasks/task-logs.spec.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react-components/lib/tasks/task-logs.spec.tsx b/packages/react-components/lib/tasks/task-logs.spec.tsx index bb9ec53c8..d66bbb21a 100644 --- a/packages/react-components/lib/tasks/task-logs.spec.tsx +++ b/packages/react-components/lib/tasks/task-logs.spec.tsx @@ -3,7 +3,7 @@ import React from 'react'; import { TaskLogs } from './task-logs'; import { makeTaskLog } from './test-data.spec'; -fdescribe('TaskLogs', () => { +describe('TaskLogs', () => { it('shows all event logs', () => { const logs = makeTaskLog('task'); const root = render( From 5872904744d4c84887bb27eb0b9d7b3b288872d3 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 21 Feb 2022 15:46:44 +0800 Subject: [PATCH 74/79] export openapi schema Signed-off-by: Teo Koon Peng --- packages/api-client/generate-openapi.sh | 8 +- packages/api-client/openapi/schema/index.ts | 3017 +++++++++++++++++ .../api-client/openapi/schema/package.json | 3 + packages/api-client/package.json | 3 +- 4 files changed, 3029 insertions(+), 2 deletions(-) create mode 100644 packages/api-client/openapi/schema/index.ts create mode 100644 packages/api-client/openapi/schema/package.json diff --git a/packages/api-client/generate-openapi.sh b/packages/api-client/generate-openapi.sh index fec4adcf4..2501e4eb2 100755 --- a/packages/api-client/generate-openapi.sh +++ b/packages/api-client/generate-openapi.sh @@ -42,4 +42,10 @@ export const version = { EOF -../../node_modules/.bin/prettier -w lib +npx prettier -w lib + +# generate schema +cat << EOF > openapi/schema/index.ts +export default $(cat build/openapi.json) +EOF +npx prettier -w openapi/schema diff --git a/packages/api-client/openapi/schema/index.ts b/packages/api-client/openapi/schema/index.ts new file mode 100644 index 000000000..f7baf3602 --- /dev/null +++ b/packages/api-client/openapi/schema/index.ts @@ -0,0 +1,3017 @@ +export default { + openapi: '3.0.2', + info: { title: 'RMF API Server', version: '0.1.0' }, + paths: { + '/socket.io': { + get: { + summary: 'Socket.io endpoint', + description: + '\n# NOTE: This endpoint is here for documentation purposes only, this is _not_ a REST endpoint.\n\n## About\nThis exposes a minimal pubsub system built on top of socket.io.\nIt works similar to a normal socket.io endpoint, except that are 2 special\nrooms which control subscriptions.\n\n## Rooms\n### subscribe\nClients must send a message to this room to start receiving messages on other rooms.\nThe message must be of the form:\n\n```\n{\n "room": ""\n}\n```\n\n### unsubscribe\nClients can send a message to this room to stop receiving messages on other rooms.\nThe message must be of the form:\n\n```\n{\n "room": ""\n}\n```\n \n### /building_map\n\n\n```\n{\n "title": "BuildingMap",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "default": "",\n "type": "string"\n },\n "levels": {\n "title": "Levels",\n "type": "array",\n "items": {\n "$ref": "#/definitions/Level"\n }\n },\n "lifts": {\n "title": "Lifts",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/Lift"\n }\n }\n },\n "required": [\n "name",\n "levels",\n "lifts"\n ],\n "definitions": {\n "AffineImage": {\n "title": "AffineImage",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "default": "",\n "type": "string"\n },\n "x_offset": {\n "title": "X Offset",\n "default": 0,\n "type": "number"\n },\n "y_offset": {\n "title": "Y Offset",\n "default": 0,\n "type": "number"\n },\n "yaw": {\n "title": "Yaw",\n "default": 0,\n "type": "number"\n },\n "scale": {\n "title": "Scale",\n "default": 0,\n "type": "number"\n },\n "encoding": {\n "title": "Encoding",\n "default": "",\n "type": "string"\n },\n "data": {\n "title": "Data",\n "type": "string"\n }\n },\n "required": [\n "name",\n "x_offset",\n "y_offset",\n "yaw",\n "scale",\n "encoding",\n "data"\n ]\n },\n "Place": {\n "title": "Place",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "default": "",\n "type": "string"\n },\n "x": {\n "title": "X",\n "default": 0,\n "type": "number"\n },\n "y": {\n "title": "Y",\n "default": 0,\n "type": "number"\n },\n "yaw": {\n "title": "Yaw",\n "default": 0,\n "type": "number"\n },\n "position_tolerance": {\n "title": "Position Tolerance",\n "default": 0,\n "type": "number"\n },\n "yaw_tolerance": {\n "title": "Yaw Tolerance",\n "default": 0,\n "type": "number"\n }\n },\n "required": [\n "name",\n "x",\n "y",\n "yaw",\n "position_tolerance",\n "yaw_tolerance"\n ]\n },\n "Door": {\n "title": "Door",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "default": "",\n "type": "string"\n },\n "v1_x": {\n "title": "V1 X",\n "default": 0,\n "type": "number"\n },\n "v1_y": {\n "title": "V1 Y",\n "default": 0,\n "type": "number"\n },\n "v2_x": {\n "title": "V2 X",\n "default": 0,\n "type": "number"\n },\n "v2_y": {\n "title": "V2 Y",\n "default": 0,\n "type": "number"\n },\n "door_type": {\n "title": "Door Type",\n "default": 0,\n "minimum": 0,\n "maximum": 255,\n "type": "integer"\n },\n "motion_range": {\n "title": "Motion Range",\n "default": 0,\n "type": "number"\n },\n "motion_direction": {\n "title": "Motion Direction",\n "default": 0,\n "minimum": -2147483648,\n "maximum": 2147483647,\n "type": "integer"\n }\n },\n "required": [\n "name",\n "v1_x",\n "v1_y",\n "v2_x",\n "v2_y",\n "door_type",\n "motion_range",\n "motion_direction"\n ]\n },\n "Param": {\n "title": "Param",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "default": "",\n "type": "string"\n },\n "type": {\n "title": "Type",\n "default": 0,\n "minimum": 0,\n "maximum": 4294967295,\n "type": "integer"\n },\n "value_int": {\n "title": "Value Int",\n "default": 0,\n "minimum": -2147483648,\n "maximum": 2147483647,\n "type": "integer"\n },\n "value_float": {\n "title": "Value Float",\n "default": 0,\n "type": "number"\n },\n "value_string": {\n "title": "Value String",\n "default": "",\n "type": "string"\n },\n "value_bool": {\n "title": "Value Bool",\n "default": false,\n "type": "boolean"\n }\n },\n "required": [\n "name",\n "type",\n "value_int",\n "value_float",\n "value_string",\n "value_bool"\n ]\n },\n "GraphNode": {\n "title": "GraphNode",\n "type": "object",\n "properties": {\n "x": {\n "title": "X",\n "default": 0,\n "type": "number"\n },\n "y": {\n "title": "Y",\n "default": 0,\n "type": "number"\n },\n "name": {\n "title": "Name",\n "default": "",\n "type": "string"\n },\n "params": {\n "title": "Params",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/Param"\n }\n }\n },\n "required": [\n "x",\n "y",\n "name",\n "params"\n ]\n },\n "GraphEdge": {\n "title": "GraphEdge",\n "type": "object",\n "properties": {\n "v1_idx": {\n "title": "V1 Idx",\n "default": 0,\n "minimum": 0,\n "maximum": 4294967295,\n "type": "integer"\n },\n "v2_idx": {\n "title": "V2 Idx",\n "default": 0,\n "minimum": 0,\n "maximum": 4294967295,\n "type": "integer"\n },\n "params": {\n "title": "Params",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/Param"\n }\n },\n "edge_type": {\n "title": "Edge Type",\n "default": 0,\n "minimum": 0,\n "maximum": 255,\n "type": "integer"\n }\n },\n "required": [\n "v1_idx",\n "v2_idx",\n "params",\n "edge_type"\n ]\n },\n "Graph": {\n "title": "Graph",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "default": "",\n "type": "string"\n },\n "vertices": {\n "title": "Vertices",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/GraphNode"\n }\n },\n "edges": {\n "title": "Edges",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/GraphEdge"\n }\n },\n "params": {\n "title": "Params",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/Param"\n }\n }\n },\n "required": [\n "name",\n "vertices",\n "edges",\n "params"\n ]\n },\n "Level": {\n "title": "Level",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "default": "",\n "type": "string"\n },\n "elevation": {\n "title": "Elevation",\n "default": 0,\n "type": "number"\n },\n "images": {\n "title": "Images",\n "type": "array",\n "items": {\n "$ref": "#/definitions/AffineImage"\n }\n },\n "places": {\n "title": "Places",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/Place"\n }\n },\n "doors": {\n "title": "Doors",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/Door"\n }\n },\n "nav_graphs": {\n "title": "Nav Graphs",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/Graph"\n }\n },\n "wall_graph": {\n "title": "Wall Graph",\n "default": {\n "name": "",\n "vertices": [],\n "edges": [],\n "params": []\n },\n "allOf": [\n {\n "$ref": "#/definitions/Graph"\n }\n ]\n }\n },\n "required": [\n "name",\n "elevation",\n "images",\n "places",\n "doors",\n "nav_graphs",\n "wall_graph"\n ]\n },\n "Lift": {\n "title": "Lift",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "default": "",\n "type": "string"\n },\n "levels": {\n "title": "Levels",\n "default": [],\n "type": "array",\n "items": {\n "type": "string"\n }\n },\n "doors": {\n "title": "Doors",\n "default": [],\n "type": "array",\n "items": {\n "$ref": "#/definitions/Door"\n }\n },\n "wall_graph": {\n "title": "Wall Graph",\n "default": {\n "name": "",\n "vertices": [],\n "edges": [],\n "params": []\n },\n "allOf": [\n {\n "$ref": "#/definitions/Graph"\n }\n ]\n },\n "ref_x": {\n "title": "Ref X",\n "default": 0,\n "type": "number"\n },\n "ref_y": {\n "title": "Ref Y",\n "default": 0,\n "type": "number"\n },\n "ref_yaw": {\n "title": "Ref Yaw",\n "default": 0,\n "type": "number"\n },\n "width": {\n "title": "Width",\n "default": 0,\n "type": "number"\n },\n "depth": {\n "title": "Depth",\n "default": 0,\n "type": "number"\n }\n },\n "required": [\n "name",\n "levels",\n "doors",\n "wall_graph",\n "ref_x",\n "ref_y",\n "ref_yaw",\n "width",\n "depth"\n ]\n }\n }\n}\n```\n\n\n### /doors/{door_name}/state\n\n\n```\n{\n "title": "DoorState",\n "type": "object",\n "properties": {\n "door_time": {\n "title": "Door Time",\n "default": {\n "sec": 0,\n "nanosec": 0\n },\n "allOf": [\n {\n "$ref": "#/definitions/Time"\n }\n ]\n },\n "door_name": {\n "title": "Door Name",\n "default": "",\n "type": "string"\n },\n "current_mode": {\n "title": "Current Mode",\n "default": {\n "value": 0\n },\n "allOf": [\n {\n "$ref": "#/definitions/DoorMode"\n }\n ]\n }\n },\n "required": [\n "door_time",\n "door_name",\n "current_mode"\n ],\n "definitions": {\n "Time": {\n "title": "Time",\n "type": "object",\n "properties": {\n "sec": {\n "title": "Sec",\n "default": 0,\n "minimum": -2147483648,\n "maximum": 2147483647,\n "type": "integer"\n },\n "nanosec": {\n "title": "Nanosec",\n "default": 0,\n "minimum": 0,\n "maximum": 4294967295,\n "type": "integer"\n }\n },\n "required": [\n "sec",\n "nanosec"\n ]\n },\n "DoorMode": {\n "title": "DoorMode",\n "type": "object",\n "properties": {\n "value": {\n "title": "Value",\n "default": 0,\n "minimum": 0,\n "maximum": 4294967295,\n "type": "integer"\n }\n },\n "required": [\n "value"\n ]\n }\n }\n}\n```\n\n\n### /doors/{door_name}/health\n\n\n```\n{\n "title": "DoorHealth",\n "type": "object",\n "properties": {\n "health_status": {\n "title": "Health Status",\n "maxLength": 255,\n "nullable": true,\n "type": "string"\n },\n "health_message": {\n "title": "Health Message",\n "nullable": true,\n "type": "string"\n },\n "id_": {\n "title": "Id ",\n "maxLength": 255,\n "type": "string"\n }\n },\n "required": [\n "health_status",\n "id_"\n ],\n "additionalProperties": false\n}\n```\n\n\n### /lifts/{lift_name}/state\n\n\n```\n{\n "title": "LiftState",\n "type": "object",\n "properties": {\n "lift_time": {\n "title": "Lift Time",\n "default": {\n "sec": 0,\n "nanosec": 0\n },\n "allOf": [\n {\n "$ref": "#/definitions/Time"\n }\n ]\n },\n "lift_name": {\n "title": "Lift Name",\n "default": "",\n "type": "string"\n },\n "available_floors": {\n "title": "Available Floors",\n "default": [],\n "type": "array",\n "items": {\n "type": "string"\n }\n },\n "current_floor": {\n "title": "Current Floor",\n "default": "",\n "type": "string"\n },\n "destination_floor": {\n "title": "Destination Floor",\n "default": "",\n "type": "string"\n },\n "door_state": {\n "title": "Door State",\n "default": 0,\n "minimum": 0,\n "maximum": 255,\n "type": "integer"\n },\n "motion_state": {\n "title": "Motion State",\n "default": 0,\n "minimum": 0,\n "maximum": 255,\n "type": "integer"\n },\n "available_modes": {\n "title": "Available Modes",\n "type": "array",\n "items": {\n "type": "integer"\n }\n },\n "current_mode": {\n "title": "Current Mode",\n "default": 0,\n "minimum": 0,\n "maximum": 255,\n "type": "integer"\n },\n "session_id": {\n "title": "Session Id",\n "default": "",\n "type": "string"\n }\n },\n "required": [\n "lift_time",\n "lift_name",\n "available_floors",\n "current_floor",\n "destination_floor",\n "door_state",\n "motion_state",\n "available_modes",\n "current_mode",\n "session_id"\n ],\n "definitions": {\n "Time": {\n "title": "Time",\n "type": "object",\n "properties": {\n "sec": {\n "title": "Sec",\n "default": 0,\n "minimum": -2147483648,\n "maximum": 2147483647,\n "type": "integer"\n },\n "nanosec": {\n "title": "Nanosec",\n "default": 0,\n "minimum": 0,\n "maximum": 4294967295,\n "type": "integer"\n }\n },\n "required": [\n "sec",\n "nanosec"\n ]\n }\n }\n}\n```\n\n\n### /lifts/{lift_name}/health\n\n\n```\n{\n "title": "LiftHealth",\n "type": "object",\n "properties": {\n "health_status": {\n "title": "Health Status",\n "maxLength": 255,\n "nullable": true,\n "type": "string"\n },\n "health_message": {\n "title": "Health Message",\n "nullable": true,\n "type": "string"\n },\n "id_": {\n "title": "Id ",\n "maxLength": 255,\n "type": "string"\n }\n },\n "required": [\n "health_status",\n "id_"\n ],\n "additionalProperties": false\n}\n```\n\n\n### /tasks/{task_id}/state\n\n\n```\n{\n "title": "TaskState",\n "type": "object",\n "properties": {\n "booking": {\n "$ref": "#/definitions/Booking"\n },\n "category": {\n "$ref": "#/definitions/Category"\n },\n "detail": {\n "$ref": "#/definitions/Detail"\n },\n "unix_millis_start_time": {\n "title": "Unix Millis Start Time",\n "type": "integer"\n },\n "unix_millis_finish_time": {\n "title": "Unix Millis Finish Time",\n "type": "integer"\n },\n "original_estimate_millis": {\n "$ref": "#/definitions/EstimateMillis"\n },\n "estimate_millis": {\n "$ref": "#/definitions/EstimateMillis"\n },\n "assigned_to": {\n "title": "Assigned To",\n "description": "Which agent (robot) is the task assigned to",\n "allOf": [\n {\n "$ref": "#/definitions/AssignedTo"\n }\n ]\n },\n "status": {\n "$ref": "#/definitions/Status"\n },\n "dispatch": {\n "$ref": "#/definitions/Dispatch"\n },\n "phases": {\n "title": "Phases",\n "description": "A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.",\n "type": "object",\n "additionalProperties": {\n "$ref": "#/definitions/Phase"\n }\n },\n "completed": {\n "title": "Completed",\n "description": "An array of the IDs of completed phases of this task",\n "type": "array",\n "items": {\n "$ref": "#/definitions/Id"\n }\n },\n "active": {\n "title": "Active",\n "description": "The ID of the active phase for this task",\n "allOf": [\n {\n "$ref": "#/definitions/Id"\n }\n ]\n },\n "pending": {\n "title": "Pending",\n "description": "An array of the pending phases of this task",\n "type": "array",\n "items": {\n "$ref": "#/definitions/Id"\n }\n },\n "interruptions": {\n "title": "Interruptions",\n "description": "A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.",\n "type": "object",\n "additionalProperties": {\n "$ref": "#/definitions/Interruption"\n }\n },\n "cancellation": {\n "title": "Cancellation",\n "description": "If the task was cancelled, this will describe information about the request.",\n "allOf": [\n {\n "$ref": "#/definitions/Cancellation"\n }\n ]\n },\n "killed": {\n "title": "Killed",\n "description": "If the task was killed, this will describe information about the request.",\n "allOf": [\n {\n "$ref": "#/definitions/Killed"\n }\n ]\n }\n },\n "required": [\n "booking"\n ],\n "definitions": {\n "Booking": {\n "title": "Booking",\n "type": "object",\n "properties": {\n "id": {\n "title": "Id",\n "description": "The unique identifier for this task",\n "type": "string"\n },\n "unix_millis_earliest_start_time": {\n "title": "Unix Millis Earliest Start Time",\n "type": "integer"\n },\n "priority": {\n "title": "Priority",\n "description": "Priority information about this task",\n "anyOf": [\n {\n "type": "object"\n },\n {\n "type": "string"\n }\n ]\n },\n "labels": {\n "title": "Labels",\n "description": "Information about how and why this task was booked",\n "type": "array",\n "items": {\n "type": "string"\n }\n }\n },\n "required": [\n "id"\n ]\n },\n "Category": {\n "title": "Category",\n "description": "The category of this task or phase",\n "type": "string"\n },\n "Detail": {\n "title": "Detail",\n "description": "Detailed information about a task, phase, or event",\n "anyOf": [\n {\n "type": "object"\n },\n {\n "type": "array",\n "items": {}\n },\n {\n "type": "string"\n }\n ]\n },\n "EstimateMillis": {\n "title": "EstimateMillis",\n "description": "An estimate, in milliseconds, of how long the subject will take to complete",\n "minimum": 0,\n "type": "integer"\n },\n "AssignedTo": {\n "title": "AssignedTo",\n "type": "object",\n "properties": {\n "group": {\n "title": "Group",\n "type": "string"\n },\n "name": {\n "title": "Name",\n "type": "string"\n }\n },\n "required": [\n "group",\n "name"\n ]\n },\n "Status": {\n "title": "Status",\n "description": "An enumeration.",\n "enum": [\n "uninitialized",\n "blocked",\n "error",\n "failed",\n "queued",\n "standby",\n "underway",\n "delayed",\n "skipped",\n "canceled",\n "killed",\n "completed"\n ]\n },\n "Status1": {\n "title": "Status1",\n "description": "An enumeration.",\n "enum": [\n "queued",\n "selected",\n "dispatched",\n "failed_to_assign",\n "canceled_in_flight"\n ]\n },\n "Assignment": {\n "title": "Assignment",\n "type": "object",\n "properties": {\n "fleet_name": {\n "title": "Fleet Name",\n "type": "string"\n },\n "expected_robot_name": {\n "title": "Expected Robot Name",\n "type": "string"\n }\n }\n },\n "Error": {\n "title": "Error",\n "type": "object",\n "properties": {\n "code": {\n "title": "Code",\n "description": "A standard code for the kind of error that has occurred",\n "minimum": 0,\n "type": "integer"\n },\n "category": {\n "title": "Category",\n "description": "The category of the error",\n "type": "string"\n },\n "detail": {\n "title": "Detail",\n "description": "Details about the error",\n "type": "string"\n }\n }\n },\n "Dispatch": {\n "title": "Dispatch",\n "type": "object",\n "properties": {\n "status": {\n "$ref": "#/definitions/Status1"\n },\n "assignment": {\n "$ref": "#/definitions/Assignment"\n },\n "errors": {\n "title": "Errors",\n "type": "array",\n "items": {\n "$ref": "#/definitions/Error"\n }\n }\n },\n "required": [\n "status"\n ]\n },\n "Id": {\n "title": "Id",\n "minimum": 0,\n "type": "integer"\n },\n "EventState": {\n "title": "EventState",\n "type": "object",\n "properties": {\n "id": {\n "$ref": "#/definitions/Id"\n },\n "status": {\n "$ref": "#/definitions/Status"\n },\n "name": {\n "title": "Name",\n "description": "The brief name of the event",\n "type": "string"\n },\n "detail": {\n "title": "Detail",\n "description": "Detailed information about the event",\n "allOf": [\n {\n "$ref": "#/definitions/Detail"\n }\n ]\n },\n "deps": {\n "title": "Deps",\n "description": "This event may depend on other events. This array contains the IDs of those other event dependencies.",\n "type": "array",\n "items": {\n "type": "integer",\n "minimum": 0\n }\n }\n },\n "required": [\n "id"\n ]\n },\n "Undo": {\n "title": "Undo",\n "type": "object",\n "properties": {\n "unix_millis_request_time": {\n "title": "Unix Millis Request Time",\n "description": "The time that the undo skip request arrived",\n "type": "integer"\n },\n "labels": {\n "title": "Labels",\n "description": "Labels to describe the undo skip request",\n "type": "array",\n "items": {\n "type": "string"\n }\n }\n },\n "required": [\n "unix_millis_request_time",\n "labels"\n ]\n },\n "SkipPhaseRequest": {\n "title": "SkipPhaseRequest",\n "type": "object",\n "properties": {\n "unix_millis_request_time": {\n "title": "Unix Millis Request Time",\n "description": "The time that the skip request arrived",\n "type": "integer"\n },\n "labels": {\n "title": "Labels",\n "description": "Labels to describe the purpose of the skip request",\n "type": "array",\n "items": {\n "type": "string"\n }\n },\n "undo": {\n "title": "Undo",\n "description": "Information about an undo skip request that applied to this request",\n "allOf": [\n {\n "$ref": "#/definitions/Undo"\n }\n ]\n }\n },\n "required": [\n "unix_millis_request_time",\n "labels"\n ]\n },\n "Phase": {\n "title": "Phase",\n "type": "object",\n "properties": {\n "id": {\n "$ref": "#/definitions/Id"\n },\n "category": {\n "$ref": "#/definitions/Category"\n },\n "detail": {\n "$ref": "#/definitions/Detail"\n },\n "unix_millis_start_time": {\n "title": "Unix Millis Start Time",\n "type": "integer"\n },\n "unix_millis_finish_time": {\n "title": "Unix Millis Finish Time",\n "type": "integer"\n },\n "original_estimate_millis": {\n "$ref": "#/definitions/EstimateMillis"\n },\n "estimate_millis": {\n "$ref": "#/definitions/EstimateMillis"\n },\n "final_event_id": {\n "$ref": "#/definitions/Id"\n },\n "events": {\n "title": "Events",\n "description": "A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.",\n "type": "object",\n "additionalProperties": {\n "$ref": "#/definitions/EventState"\n }\n },\n "skip_requests": {\n "title": "Skip Requests",\n "description": "Information about any skip requests that have been received",\n "type": "object",\n "additionalProperties": {\n "$ref": "#/definitions/SkipPhaseRequest"\n }\n }\n },\n "required": [\n "id"\n ]\n },\n "ResumedBy": {\n "title": "ResumedBy",\n "type": "object",\n "properties": {\n "unix_millis_request_time": {\n "title": "Unix Millis Request Time",\n "description": "The time that the resume request arrived",\n "type": "integer"\n },\n "labels": {\n "title": "Labels",\n "description": "Labels to describe the resume request",\n "type": "array",\n "items": {\n "type": "string"\n }\n }\n },\n "required": [\n "labels"\n ]\n },\n "Interruption": {\n "title": "Interruption",\n "type": "object",\n "properties": {\n "unix_millis_request_time": {\n "title": "Unix Millis Request Time",\n "description": "The time that the interruption request arrived",\n "type": "integer"\n },\n "labels": {\n "title": "Labels",\n "description": "Labels to describe the purpose of the interruption",\n "type": "array",\n "items": {\n "type": "string"\n }\n },\n "resumed_by": {\n "title": "Resumed By",\n "description": "Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.",\n "allOf": [\n {\n "$ref": "#/definitions/ResumedBy"\n }\n ]\n }\n },\n "required": [\n "unix_millis_request_time",\n "labels"\n ]\n },\n "Cancellation": {\n "title": "Cancellation",\n "type": "object",\n "properties": {\n "unix_millis_request_time": {\n "title": "Unix Millis Request Time",\n "description": "The time that the cancellation request arrived",\n "type": "integer"\n },\n "labels": {\n "title": "Labels",\n "description": "Labels to describe the cancel request",\n "type": "array",\n "items": {\n "type": "string"\n }\n }\n },\n "required": [\n "unix_millis_request_time",\n "labels"\n ]\n },\n "Killed": {\n "title": "Killed",\n "type": "object",\n "properties": {\n "unix_millis_request_time": {\n "title": "Unix Millis Request Time",\n "description": "The time that the cancellation request arrived",\n "type": "integer"\n },\n "labels": {\n "title": "Labels",\n "description": "Labels to describe the kill request",\n "type": "array",\n "items": {\n "type": "string"\n }\n }\n },\n "required": [\n "unix_millis_request_time",\n "labels"\n ]\n }\n }\n}\n```\n\n\n### /tasks/{task_id}/log\n\n\n```\n{\n "title": "TaskEventLog",\n "type": "object",\n "properties": {\n "task_id": {\n "title": "Task Id",\n "type": "string"\n },\n "log": {\n "title": "Log",\n "description": "Log entries related to the overall task",\n "type": "array",\n "items": {\n "$ref": "#/definitions/LogEntry"\n }\n },\n "phases": {\n "title": "Phases",\n "description": "A dictionary whose keys (property names) are the indices of a phase",\n "type": "object",\n "additionalProperties": {\n "$ref": "#/definitions/Phases"\n }\n }\n },\n "required": [\n "task_id"\n ],\n "additionalProperties": false,\n "definitions": {\n "Tier": {\n "title": "Tier",\n "description": "An enumeration.",\n "enum": [\n "uninitialized",\n "info",\n "warning",\n "error"\n ]\n },\n "LogEntry": {\n "title": "LogEntry",\n "type": "object",\n "properties": {\n "seq": {\n "title": "Seq",\n "description": "Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.",\n "exclusiveMaximum": 4294967296,\n "minimum": 0,\n "type": "integer"\n },\n "tier": {\n "description": "The importance level of the log entry",\n "allOf": [\n {\n "$ref": "#/definitions/Tier"\n }\n ]\n },\n "unix_millis_time": {\n "title": "Unix Millis Time",\n "type": "integer"\n },\n "text": {\n "title": "Text",\n "description": "The text of the log entry",\n "type": "string"\n }\n },\n "required": [\n "seq",\n "tier",\n "unix_millis_time",\n "text"\n ]\n },\n "Phases": {\n "title": "Phases",\n "type": "object",\n "properties": {\n "log": {\n "title": "Log",\n "description": "Log entries related to the overall phase",\n "type": "array",\n "items": {\n "$ref": "#/definitions/LogEntry"\n }\n },\n "events": {\n "title": "Events",\n "description": "A dictionary whose keys (property names) are the indices of an event in the phase",\n "type": "object",\n "additionalProperties": {\n "type": "array",\n "items": {\n "$ref": "#/definitions/LogEntry"\n }\n }\n }\n },\n "additionalProperties": false\n }\n }\n}\n```\n\n\n### /dispensers/{guid}/state\n\n\n```\n{\n "title": "DispenserState",\n "type": "object",\n "properties": {\n "time": {\n "title": "Time",\n "default": {\n "sec": 0,\n "nanosec": 0\n },\n "allOf": [\n {\n "$ref": "#/definitions/Time"\n }\n ]\n },\n "guid": {\n "title": "Guid",\n "default": "",\n "type": "string"\n },\n "mode": {\n "title": "Mode",\n "default": 0,\n "minimum": -2147483648,\n "maximum": 2147483647,\n "type": "integer"\n },\n "request_guid_queue": {\n "title": "Request Guid Queue",\n "default": [],\n "type": "array",\n "items": {\n "type": "string"\n }\n },\n "seconds_remaining": {\n "title": "Seconds Remaining",\n "default": 0,\n "type": "number"\n }\n },\n "required": [\n "time",\n "guid",\n "mode",\n "request_guid_queue",\n "seconds_remaining"\n ],\n "definitions": {\n "Time": {\n "title": "Time",\n "type": "object",\n "properties": {\n "sec": {\n "title": "Sec",\n "default": 0,\n "minimum": -2147483648,\n "maximum": 2147483647,\n "type": "integer"\n },\n "nanosec": {\n "title": "Nanosec",\n "default": 0,\n "minimum": 0,\n "maximum": 4294967295,\n "type": "integer"\n }\n },\n "required": [\n "sec",\n "nanosec"\n ]\n }\n }\n}\n```\n\n\n### /dispensers/{guid}/health\n\n\n```\n{\n "title": "DispenserHealth",\n "type": "object",\n "properties": {\n "health_status": {\n "title": "Health Status",\n "maxLength": 255,\n "nullable": true,\n "type": "string"\n },\n "health_message": {\n "title": "Health Message",\n "nullable": true,\n "type": "string"\n },\n "id_": {\n "title": "Id ",\n "maxLength": 255,\n "type": "string"\n }\n },\n "required": [\n "health_status",\n "id_"\n ],\n "additionalProperties": false\n}\n```\n\n\n### /ingestors/{guid}/state\n\n\n```\n{\n "title": "IngestorState",\n "type": "object",\n "properties": {\n "time": {\n "title": "Time",\n "default": {\n "sec": 0,\n "nanosec": 0\n },\n "allOf": [\n {\n "$ref": "#/definitions/Time"\n }\n ]\n },\n "guid": {\n "title": "Guid",\n "default": "",\n "type": "string"\n },\n "mode": {\n "title": "Mode",\n "default": 0,\n "minimum": -2147483648,\n "maximum": 2147483647,\n "type": "integer"\n },\n "request_guid_queue": {\n "title": "Request Guid Queue",\n "default": [],\n "type": "array",\n "items": {\n "type": "string"\n }\n },\n "seconds_remaining": {\n "title": "Seconds Remaining",\n "default": 0,\n "type": "number"\n }\n },\n "required": [\n "time",\n "guid",\n "mode",\n "request_guid_queue",\n "seconds_remaining"\n ],\n "definitions": {\n "Time": {\n "title": "Time",\n "type": "object",\n "properties": {\n "sec": {\n "title": "Sec",\n "default": 0,\n "minimum": -2147483648,\n "maximum": 2147483647,\n "type": "integer"\n },\n "nanosec": {\n "title": "Nanosec",\n "default": 0,\n "minimum": 0,\n "maximum": 4294967295,\n "type": "integer"\n }\n },\n "required": [\n "sec",\n "nanosec"\n ]\n }\n }\n}\n```\n\n\n### /ingestors/{guid}/health\n\n\n```\n{\n "title": "IngestorHealth",\n "type": "object",\n "properties": {\n "health_status": {\n "title": "Health Status",\n "maxLength": 255,\n "nullable": true,\n "type": "string"\n },\n "health_message": {\n "title": "Health Message",\n "nullable": true,\n "type": "string"\n },\n "id_": {\n "title": "Id ",\n "maxLength": 255,\n "type": "string"\n }\n },\n "required": [\n "health_status",\n "id_"\n ],\n "additionalProperties": false\n}\n```\n\n\n### /fleets/{name}/state\n\n\n```\n{\n "title": "FleetState",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "type": "string"\n },\n "robots": {\n "title": "Robots",\n "description": "A dictionary of the states of the robots that belong to this fleet",\n "type": "object",\n "additionalProperties": {\n "$ref": "#/definitions/RobotState"\n }\n }\n },\n "definitions": {\n "Status2": {\n "title": "Status2",\n "description": "An enumeration.",\n "enum": [\n "uninitialized",\n "offline",\n "shutdown",\n "idle",\n "charging",\n "working",\n "error"\n ]\n },\n "Location2D": {\n "title": "Location2D",\n "type": "object",\n "properties": {\n "map": {\n "title": "Map",\n "type": "string"\n },\n "x": {\n "title": "X",\n "type": "number"\n },\n "y": {\n "title": "Y",\n "type": "number"\n },\n "yaw": {\n "title": "Yaw",\n "type": "number"\n }\n },\n "required": [\n "map",\n "x",\n "y",\n "yaw"\n ]\n },\n "Issue": {\n "title": "Issue",\n "type": "object",\n "properties": {\n "category": {\n "title": "Category",\n "description": "Category of the robot\'s issue",\n "type": "string"\n },\n "detail": {\n "title": "Detail",\n "description": "Detailed information about the issue",\n "anyOf": [\n {\n "type": "object"\n },\n {\n "type": "array",\n "items": {}\n },\n {\n "type": "string"\n }\n ]\n }\n }\n },\n "RobotState": {\n "title": "RobotState",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "type": "string"\n },\n "status": {\n "description": "A simple token representing the status of the robot",\n "allOf": [\n {\n "$ref": "#/definitions/Status2"\n }\n ]\n },\n "task_id": {\n "title": "Task Id",\n "description": "The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.",\n "type": "string"\n },\n "unix_millis_time": {\n "title": "Unix Millis Time",\n "type": "integer"\n },\n "location": {\n "$ref": "#/definitions/Location2D"\n },\n "battery": {\n "title": "Battery",\n "description": "State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)",\n "minimum": 0.0,\n "maximum": 1.0,\n "type": "number"\n },\n "issues": {\n "title": "Issues",\n "description": "A list of issues with the robot that operators need to address",\n "type": "array",\n "items": {\n "$ref": "#/definitions/Issue"\n }\n }\n }\n }\n }\n}\n```\n\n\n### /fleets/{name}/log\n\n\n```\n{\n "title": "FleetLog",\n "type": "object",\n "properties": {\n "name": {\n "title": "Name",\n "type": "string"\n },\n "log": {\n "title": "Log",\n "description": "Log for the overall fleet",\n "type": "array",\n "items": {\n "$ref": "#/definitions/LogEntry"\n }\n },\n "robots": {\n "title": "Robots",\n "description": "Dictionary of logs for the individual robots. The keys (property names) are the robot names.",\n "type": "object",\n "additionalProperties": {\n "type": "array",\n "items": {\n "$ref": "#/definitions/LogEntry"\n }\n }\n }\n },\n "definitions": {\n "Tier": {\n "title": "Tier",\n "description": "An enumeration.",\n "enum": [\n "uninitialized",\n "info",\n "warning",\n "error"\n ]\n },\n "LogEntry": {\n "title": "LogEntry",\n "type": "object",\n "properties": {\n "seq": {\n "title": "Seq",\n "description": "Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.",\n "exclusiveMaximum": 4294967296,\n "minimum": 0,\n "type": "integer"\n },\n "tier": {\n "description": "The importance level of the log entry",\n "allOf": [\n {\n "$ref": "#/definitions/Tier"\n }\n ]\n },\n "unix_millis_time": {\n "title": "Unix Millis Time",\n "type": "integer"\n },\n "text": {\n "title": "Text",\n "description": "The text of the log entry",\n "type": "string"\n }\n },\n "required": [\n "seq",\n "tier",\n "unix_millis_time",\n "text"\n ]\n }\n }\n}\n```\n\n', + operationId: '_lambda__socket_io_get', + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + }, + }, + }, + '/user': { + get: { + summary: 'Get User', + description: 'Get the currently logged in user', + operationId: 'get_user_user_get', + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: { $ref: '#/components/schemas/User' } } }, + }, + }, + }, + }, + '/permissions': { + get: { + summary: 'Get Effective Permissions', + description: 'Get the effective permissions of the current user', + operationId: 'get_effective_permissions_permissions_get', + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { + title: 'Response Get Effective Permissions Permissions Get', + type: 'array', + items: { $ref: '#/components/schemas/Permission' }, + }, + }, + }, + }, + }, + }, + }, + '/time': { + get: { + summary: 'Get Time', + description: 'Get the current rmf time in unix milliseconds', + operationId: 'get_time_time_get', + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { title: 'Response Get Time Time Get', type: 'integer' }, + }, + }, + }, + }, + }, + }, + '/building_map': { + get: { + tags: ['Building'], + summary: 'Get Building Map', + description: 'Available in socket.io', + operationId: 'get_building_map_building_map_get', + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/BuildingMap' } }, + }, + }, + }, + }, + }, + '/doors': { + get: { + tags: ['Doors'], + summary: 'Get Doors', + operationId: 'get_doors_doors_get', + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { + title: 'Response Get Doors Doors Get', + type: 'array', + items: { $ref: '#/components/schemas/Door' }, + }, + }, + }, + }, + }, + }, + }, + '/doors/{door_name}/state': { + get: { + tags: ['Doors'], + summary: 'Get Door State', + description: 'Available in socket.io', + operationId: 'get_door_state_doors__door_name__state_get', + parameters: [ + { + required: true, + schema: { title: 'Door Name', type: 'string' }, + name: 'door_name', + in: 'path', + }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: { $ref: '#/components/schemas/DoorState' } } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/doors/{door_name}/health': { + get: { + tags: ['Doors'], + summary: 'Get Door Health', + description: 'Available in socket.io', + operationId: 'get_door_health_doors__door_name__health_get', + parameters: [ + { + required: true, + schema: { title: 'Door Name', type: 'string' }, + name: 'door_name', + in: 'path', + }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/DoorHealth' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/doors/{door_name}/request': { + post: { + tags: ['Doors'], + summary: 'Post Door Request', + operationId: 'post_door_request_doors__door_name__request_post', + parameters: [ + { + required: true, + schema: { title: 'Door Name', type: 'string' }, + name: 'door_name', + in: 'path', + }, + ], + requestBody: { + content: { 'application/json': { schema: { $ref: '#/components/schemas/DoorRequest' } } }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/lifts': { + get: { + tags: ['Lifts'], + summary: 'Get Lifts', + operationId: 'get_lifts_lifts_get', + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { + title: 'Response Get Lifts Lifts Get', + type: 'array', + items: { $ref: '#/components/schemas/Lift' }, + }, + }, + }, + }, + }, + }, + }, + '/lifts/{lift_name}/state': { + get: { + tags: ['Lifts'], + summary: 'Get Lift State', + description: 'Available in socket.io', + operationId: 'get_lift_state_lifts__lift_name__state_get', + parameters: [ + { + required: true, + schema: { title: 'Lift Name', type: 'string' }, + name: 'lift_name', + in: 'path', + }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: { $ref: '#/components/schemas/LiftState' } } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/lifts/{lift_name}/health': { + get: { + tags: ['Lifts'], + summary: 'Get Lift Health', + description: 'Available in socket.io', + operationId: 'get_lift_health_lifts__lift_name__health_get', + parameters: [ + { + required: true, + schema: { title: 'Lift Name', type: 'string' }, + name: 'lift_name', + in: 'path', + }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/LiftHealth' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/lifts/{lift_name}/request': { + post: { + tags: ['Lifts'], + summary: ' Post Lift Request', + operationId: '_post_lift_request_lifts__lift_name__request_post', + parameters: [ + { + required: true, + schema: { title: 'Lift Name', type: 'string' }, + name: 'lift_name', + in: 'path', + }, + ], + requestBody: { + content: { 'application/json': { schema: { $ref: '#/components/schemas/LiftRequest' } } }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks': { + get: { + tags: ['Tasks'], + summary: 'Query Task States', + operationId: 'query_task_states_tasks_get', + parameters: [ + { + description: 'comma separated list of task ids', + required: false, + schema: { + title: 'Task Id', + type: 'string', + description: 'comma separated list of task ids', + }, + name: 'task_id', + in: 'query', + }, + { + description: 'comma separated list of task categories', + required: false, + schema: { + title: 'Category', + type: 'string', + description: 'comma separated list of task categories', + }, + name: 'category', + in: 'query', + }, + { + required: false, + schema: { title: 'Start Time', type: 'string', format: 'date-time' }, + name: 'start_time', + in: 'query', + }, + { + required: false, + schema: { title: 'Finish Time', type: 'string', format: 'date-time' }, + name: 'finish_time', + in: 'query', + }, + { + required: false, + schema: { + title: 'Limit', + maximum: 100.0, + exclusiveMinimum: 0.0, + type: 'integer', + default: 100, + }, + name: 'limit', + in: 'query', + }, + { + required: false, + schema: { + title: 'Offset', + maximum: 1000000.0, + minimum: 0.0, + type: 'integer', + default: 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: { + title: 'Response Query Task States Tasks Get', + type: 'array', + items: { $ref: '#/components/schemas/TaskState' }, + }, + }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/{task_id}/state': { + get: { + tags: ['Tasks'], + summary: 'Get Task State', + description: 'Available in socket.io', + operationId: 'get_task_state_tasks__task_id__state_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/TaskState' } } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/{task_id}/log': { + get: { + tags: ['Tasks'], + summary: 'Get Task Log', + description: 'Available in socket.io', + operationId: 'get_task_log_tasks__task_id__log_get', + parameters: [ + { + description: 'task_id', + required: true, + schema: { title: 'Task Id', type: 'string', description: 'task_id' }, + name: 'task_id', + in: 'path', + }, + { + description: + '\n The period of time to fetch, in unix millis.\n\n This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis.\n\n Example:\n "1000,2000" - Fetches logs between unix millis 1000 and 2000.\n "-60000" - Fetches logs in the last minute.\n ', + required: false, + schema: { + title: 'Between', + type: 'string', + description: + '\n The period of time to fetch, in unix millis.\n\n This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis.\n\n Example:\n "1000,2000" - Fetches logs between unix millis 1000 and 2000.\n "-60000" - Fetches logs in the last minute.\n ', + default: '-60000', + }, + name: 'between', + in: 'query', + }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskEventLog' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/activity_discovery': { + post: { + tags: ['Tasks'], + summary: 'Post Activity Discovery', + operationId: 'post_activity_discovery_tasks_activity_discovery_post', + requestBody: { + content: { + 'application/json': { + schema: { $ref: '#/components/schemas/ActivityDiscoveryRequest' }, + }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/ActivityDiscovery' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/cancel_task': { + post: { + tags: ['Tasks'], + summary: 'Post Cancel Task', + operationId: 'post_cancel_task_tasks_cancel_task_post', + requestBody: { + content: { + 'application/json': { schema: { $ref: '#/components/schemas/CancelTaskRequest' } }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskCancelResponse' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/dispatch_task': { + post: { + tags: ['Tasks'], + summary: 'Post Dispatch Task', + operationId: 'post_dispatch_task_tasks_dispatch_task_post', + requestBody: { + content: { + 'application/json': { schema: { $ref: '#/components/schemas/DispatchTaskRequest' } }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { $ref: '#/components/schemas/TaskDispatchResponseItem' }, + }, + }, + }, + '400': { + description: 'Bad Request', + content: { + 'application/json': { + schema: { $ref: '#/components/schemas/TaskDispatchResponseItem1' }, + }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/interrupt_task': { + post: { + tags: ['Tasks'], + summary: 'Post Interrupt Task', + operationId: 'post_interrupt_task_tasks_interrupt_task_post', + requestBody: { + content: { + 'application/json': { + schema: { $ref: '#/components/schemas/TaskInterruptionRequest' }, + }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { $ref: '#/components/schemas/TaskInterruptionResponse' }, + }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/kill_task': { + post: { + tags: ['Tasks'], + summary: 'Post Kill Task', + operationId: 'post_kill_task_tasks_kill_task_post', + requestBody: { + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskKillRequest' } }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskKillResponse' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/resume_task': { + post: { + tags: ['Tasks'], + summary: 'Post Resume Task', + operationId: 'post_resume_task_tasks_resume_task_post', + requestBody: { + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskResumeRequest' } }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskResumeResponse' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/rewind_task': { + post: { + tags: ['Tasks'], + summary: 'Post Rewind Task', + operationId: 'post_rewind_task_tasks_rewind_task_post', + requestBody: { + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskRewindRequest' } }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskRewindResponse' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/skip_phase': { + post: { + tags: ['Tasks'], + summary: 'Post Skip Phase', + operationId: 'post_skip_phase_tasks_skip_phase_post', + requestBody: { + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskPhaseSkipRequest' } }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/SkipPhaseResponse' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/task_discovery': { + post: { + tags: ['Tasks'], + summary: 'Post Task Discovery', + operationId: 'post_task_discovery_tasks_task_discovery_post', + requestBody: { + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskDiscoveryRequest' } }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/TaskDiscovery' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/tasks/undo_skip_phase': { + post: { + tags: ['Tasks'], + summary: 'Post Undo Skip Phase', + operationId: 'post_undo_skip_phase_tasks_undo_skip_phase_post', + requestBody: { + content: { + 'application/json': { schema: { $ref: '#/components/schemas/UndoPhaseSkipRequest' } }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { $ref: '#/components/schemas/UndoPhaseSkipResponse' }, + }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/dispensers': { + get: { + tags: ['Dispensers'], + summary: 'Get Dispensers', + operationId: 'get_dispensers_dispensers_get', + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { + title: 'Response Get Dispensers Dispensers Get', + type: 'array', + items: { $ref: '#/components/schemas/Dispenser' }, + }, + }, + }, + }, + }, + }, + }, + '/dispensers/{guid}/state': { + get: { + tags: ['Dispensers'], + summary: 'Get Dispenser State', + description: 'Available in socket.io', + operationId: 'get_dispenser_state_dispensers__guid__state_get', + parameters: [ + { required: true, schema: { title: 'Guid', type: 'string' }, name: 'guid', in: 'path' }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/DispenserState' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/dispensers/{guid}/health': { + get: { + tags: ['Dispensers'], + summary: 'Get Dispenser Health', + description: 'Available in socket.io', + operationId: 'get_dispenser_health_dispensers__guid__health_get', + parameters: [ + { required: true, schema: { title: 'Guid', type: 'string' }, name: 'guid', in: 'path' }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/DispenserHealth' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/ingestors': { + get: { + tags: ['Ingestors'], + summary: 'Get Ingestors', + operationId: 'get_ingestors_ingestors_get', + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { + title: 'Response Get Ingestors Ingestors Get', + type: 'array', + items: { $ref: '#/components/schemas/Ingestor' }, + }, + }, + }, + }, + }, + }, + }, + '/ingestors/{guid}/state': { + get: { + tags: ['Ingestors'], + summary: 'Get Ingestor State', + description: 'Available in socket.io', + operationId: 'get_ingestor_state_ingestors__guid__state_get', + parameters: [ + { required: true, schema: { title: 'Guid', type: 'string' }, name: 'guid', in: 'path' }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/IngestorState' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/ingestors/{guid}/health': { + get: { + tags: ['Ingestors'], + summary: 'Get Ingestor Health', + description: 'Available in socket.io', + operationId: 'get_ingestor_health_ingestors__guid__health_get', + parameters: [ + { required: true, schema: { title: 'Guid', type: 'string' }, name: 'guid', in: 'path' }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/IngestorHealth' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/fleets': { + get: { + tags: ['Fleets'], + summary: 'Get Fleets', + operationId: 'get_fleets_fleets_get', + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { + title: 'Response Get Fleets Fleets Get', + type: 'array', + items: { $ref: '#/components/schemas/FleetState' }, + }, + }, + }, + }, + }, + }, + }, + '/fleets/{name}/state': { + get: { + tags: ['Fleets'], + summary: 'Get Fleet State', + description: 'Available in socket.io', + operationId: 'get_fleet_state_fleets__name__state_get', + parameters: [ + { required: true, schema: { title: 'Name', type: 'string' }, name: 'name', in: 'path' }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/FleetState' } }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/fleets/{name}/log': { + get: { + tags: ['Fleets'], + summary: 'Get Fleet Log', + description: 'Available in socket.io', + operationId: 'get_fleet_log_fleets__name__log_get', + parameters: [ + { required: true, schema: { title: 'Name', type: 'string' }, name: 'name', in: 'path' }, + { + description: + '\n The period of time to fetch, in unix millis.\n\n This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis.\n\n Example:\n "1000,2000" - Fetches logs between unix millis 1000 and 2000.\n "-60000" - Fetches logs in the last minute.\n ', + required: false, + schema: { + title: 'Between', + type: 'string', + description: + '\n The period of time to fetch, in unix millis.\n\n This can be either a comma separated string or a string prefixed with \'-\' to fetch the last X millis.\n\n Example:\n "1000,2000" - Fetches logs between unix millis 1000 and 2000.\n "-60000" - Fetches logs in the last minute.\n ', + default: '-60000', + }, + name: 'between', + in: 'query', + }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: { $ref: '#/components/schemas/FleetLog' } } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/admin/users': { + get: { + tags: ['Admin'], + summary: 'Get Users', + description: 'Search users', + operationId: 'get_users_admin_users_get', + parameters: [ + { + description: 'filters username that starts with the value', + required: false, + schema: { + title: 'Username', + type: 'string', + description: 'filters username that starts with the value', + }, + name: 'username', + in: 'query', + }, + { + required: false, + schema: { title: 'Is Admin', type: 'boolean' }, + name: 'is_admin', + in: 'query', + }, + { + required: false, + schema: { + title: 'Limit', + maximum: 100.0, + exclusiveMinimum: 0.0, + type: 'integer', + default: 100, + }, + name: 'limit', + in: 'query', + }, + { + required: false, + schema: { + title: 'Offset', + maximum: 1000000.0, + minimum: 0.0, + type: 'integer', + default: 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: { + title: 'Response Get Users Admin Users Get', + type: 'array', + items: { type: 'string' }, + }, + }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + post: { + tags: ['Admin'], + summary: 'Create User', + description: 'Create a user', + operationId: 'create_user_admin_users_post', + requestBody: { + content: { 'application/json': { schema: { $ref: '#/components/schemas/PostUsers' } } }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/admin/users/{username}': { + get: { + tags: ['Admin'], + summary: 'Get User', + description: 'Get a user', + operationId: 'get_user_admin_users__username__get', + parameters: [ + { + required: true, + schema: { title: 'Username', type: 'string' }, + name: 'username', + in: 'path', + }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: { $ref: '#/components/schemas/User' } } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + delete: { + tags: ['Admin'], + summary: 'Delete User', + description: + 'Delete a user\n\nThis only performs a soft delete, while the user is deleted from the app database,\nit still exists in the idp so they can still log in, the user will then be re-created\nwith the default permissions.', + operationId: 'delete_user_admin_users__username__delete', + parameters: [ + { + required: true, + schema: { title: 'Username', type: 'string' }, + name: 'username', + in: 'path', + }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/admin/users/{username}/make_admin': { + post: { + tags: ['Admin'], + summary: 'Make Admin', + description: 'Make or remove admin privilege from a user', + operationId: 'make_admin_admin_users__username__make_admin_post', + parameters: [ + { + required: true, + schema: { title: 'Username', type: 'string' }, + name: 'username', + in: 'path', + }, + ], + requestBody: { + content: { + 'application/json': { schema: { $ref: '#/components/schemas/PostMakeAdmin' } }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/admin/users/{username}/roles': { + put: { + tags: ['Admin'], + summary: 'Set User Roles', + description: 'Set the roles of a user', + operationId: 'set_user_roles_admin_users__username__roles_put', + parameters: [ + { + required: true, + schema: { title: 'Username', type: 'string' }, + name: 'username', + in: 'path', + }, + ], + requestBody: { + content: { + 'application/json': { + schema: { + title: 'Body', + type: 'array', + items: { $ref: '#/components/schemas/PostRoles' }, + }, + }, + }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + post: { + tags: ['Admin'], + summary: 'Add User Role', + description: 'Add role to a user', + operationId: 'add_user_role_admin_users__username__roles_post', + parameters: [ + { + required: true, + schema: { title: 'Username', type: 'string' }, + name: 'username', + in: 'path', + }, + ], + requestBody: { + content: { 'application/json': { schema: { $ref: '#/components/schemas/PostRoles' } } }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/admin/users/{username}/roles/{role}': { + delete: { + tags: ['Admin'], + summary: 'Delete User Role', + description: 'Remove role from a user', + operationId: 'delete_user_role_admin_users__username__roles__role__delete', + parameters: [ + { + required: true, + schema: { title: 'Username', type: 'string' }, + name: 'username', + in: 'path', + }, + { required: true, schema: { title: 'Role', type: 'string' }, name: 'role', in: 'path' }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/admin/roles': { + get: { + tags: ['Admin'], + summary: 'Get Roles', + description: 'Get all roles', + operationId: 'get_roles_admin_roles_get', + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { + title: 'Response Get Roles Admin Roles Get', + type: 'array', + items: { type: 'string' }, + }, + }, + }, + }, + }, + }, + post: { + tags: ['Admin'], + summary: 'Create Role', + description: 'Create a new role', + operationId: 'create_role_admin_roles_post', + requestBody: { + content: { 'application/json': { schema: { $ref: '#/components/schemas/PostRoles' } } }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/admin/roles/{role}': { + delete: { + tags: ['Admin'], + summary: 'Delete Role', + description: 'Delete a role', + operationId: 'delete_role_admin_roles__role__delete', + parameters: [ + { required: true, schema: { title: 'Role', type: 'string' }, name: 'role', in: 'path' }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/admin/roles/{role}/permissions': { + get: { + tags: ['Admin'], + summary: 'Get Role Permissions', + description: 'Get all permissions of a role', + operationId: 'get_role_permissions_admin_roles__role__permissions_get', + parameters: [ + { required: true, schema: { title: 'Role', type: 'string' }, name: 'role', in: 'path' }, + ], + responses: { + '200': { + description: 'Successful Response', + content: { + 'application/json': { + schema: { + title: 'Response Get Role Permissions Admin Roles Role Permissions Get', + type: 'array', + items: { $ref: '#/components/schemas/Permission' }, + }, + }, + }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + post: { + tags: ['Admin'], + summary: 'Add Role Permission', + description: 'Add a permission to a role', + operationId: 'add_role_permission_admin_roles__role__permissions_post', + parameters: [ + { required: true, schema: { title: 'Role', type: 'string' }, name: 'role', in: 'path' }, + ], + requestBody: { + content: { 'application/json': { schema: { $ref: '#/components/schemas/Permission' } } }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + '/admin/roles/{role}/permissions/remove': { + post: { + tags: ['Admin'], + summary: 'Remove Role Permission', + description: 'Delete a permission from a role', + operationId: 'remove_role_permission_admin_roles__role__permissions_remove_post', + parameters: [ + { required: true, schema: { title: 'Role', type: 'string' }, name: 'role', in: 'path' }, + ], + requestBody: { + content: { 'application/json': { schema: { $ref: '#/components/schemas/Permission' } } }, + required: true, + }, + responses: { + '200': { + description: 'Successful Response', + content: { 'application/json': { schema: {} } }, + }, + '422': { + description: 'Validation Error', + content: { + 'application/json': { schema: { $ref: '#/components/schemas/HTTPValidationError' } }, + }, + }, + }, + }, + }, + }, + components: { + schemas: { + Activity: { + title: 'Activity', + required: ['category', 'detail'], + type: 'object', + properties: { + category: { + title: 'Category', + type: 'string', + description: + 'The category of this activity. There must not be any duplicate activity categories per fleet.', + }, + detail: { + title: 'Detail', + type: 'string', + description: 'Details about the behavior of the activity.', + }, + description_schema: { + title: 'Description Schema', + type: 'object', + description: 'The schema for this activity description', + }, + }, + }, + ActivityDiscovery: { + title: 'ActivityDiscovery', + type: 'object', + properties: { + data: { title: 'Data', type: 'array', items: { $ref: '#/components/schemas/Datum' } }, + }, + }, + ActivityDiscoveryRequest: { + title: 'ActivityDiscoveryRequest', + required: ['type'], + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['activitiy_discovery_request'], + type: 'string', + description: 'Indicate that this is an activity discovery request', + }, + }, + }, + AffineImage: { + title: 'AffineImage', + required: ['name', 'x_offset', 'y_offset', 'yaw', 'scale', 'encoding', 'data'], + type: 'object', + properties: { + name: { title: 'Name', type: 'string', default: '' }, + x_offset: { title: 'X Offset', type: 'number', default: 0 }, + y_offset: { title: 'Y Offset', type: 'number', default: 0 }, + yaw: { title: 'Yaw', type: 'number', default: 0 }, + scale: { title: 'Scale', type: 'number', default: 0 }, + encoding: { title: 'Encoding', type: 'string', default: '' }, + data: { title: 'Data', type: 'string' }, + }, + }, + AssignedTo: { + title: 'AssignedTo', + required: ['group', 'name'], + type: 'object', + properties: { + group: { title: 'Group', type: 'string' }, + name: { title: 'Name', type: 'string' }, + }, + }, + Assignment: { + title: 'Assignment', + type: 'object', + properties: { + fleet_name: { title: 'Fleet Name', type: 'string' }, + expected_robot_name: { title: 'Expected Robot Name', type: 'string' }, + }, + }, + Booking: { + title: 'Booking', + required: ['id'], + type: 'object', + properties: { + id: { title: 'Id', type: 'string', description: 'The unique identifier for this task' }, + unix_millis_earliest_start_time: { + title: 'Unix Millis Earliest Start Time', + type: 'integer', + }, + priority: { + title: 'Priority', + anyOf: [{ type: 'object' }, { type: 'string' }], + description: 'Priority information about this task', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Information about how and why this task was booked', + }, + }, + }, + BuildingMap: { + title: 'BuildingMap', + required: ['name', 'levels', 'lifts'], + type: 'object', + properties: { + name: { title: 'Name', type: 'string', default: '' }, + levels: { title: 'Levels', type: 'array', items: { $ref: '#/components/schemas/Level' } }, + lifts: { + title: 'Lifts', + type: 'array', + items: { $ref: '#/components/schemas/Lift' }, + default: [], + }, + }, + }, + CancelTaskRequest: { + title: 'CancelTaskRequest', + required: ['type', 'task_id'], + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['cancel_task_request'], + type: 'string', + description: 'Indicate that this is a task cancellation request', + }, + task_id: { + title: 'Task Id', + type: 'string', + description: 'Specify the task ID to cancel', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the purpose of the cancellation', + }, + }, + }, + Cancellation: { + title: 'Cancellation', + required: ['unix_millis_request_time', 'labels'], + type: 'object', + properties: { + unix_millis_request_time: { + title: 'Unix Millis Request Time', + type: 'integer', + description: 'The time that the cancellation request arrived', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the cancel request', + }, + }, + }, + Category: { + title: 'Category', + type: 'string', + description: 'The category of this task or phase', + }, + Data: { + title: 'Data', + type: 'object', + properties: { + fleet_name: { + title: 'Fleet Name', + type: 'string', + description: 'Name of the fleet that supports these tasks', + }, + tasks: { + title: 'Tasks', + type: 'array', + items: { $ref: '#/components/schemas/Task' }, + description: '(list:replace) List of tasks that the fleet supports', + }, + }, + }, + Datum: { + title: 'Datum', + required: ['fleet_name', 'activities'], + type: 'object', + properties: { + fleet_name: { + title: 'Fleet Name', + type: 'string', + description: 'Name of the fleet that supports these activities', + }, + activities: { + title: 'Activities', + type: 'array', + items: { $ref: '#/components/schemas/Activity' }, + description: 'List of activities that the fleet supports', + }, + }, + }, + Detail: { + title: 'Detail', + anyOf: [{ type: 'object' }, { type: 'array', items: {} }, { type: 'string' }], + description: 'Detailed information about a task, phase, or event', + }, + Dispatch: { + title: 'Dispatch', + required: ['status'], + type: 'object', + properties: { + status: { $ref: '#/components/schemas/Status1' }, + assignment: { $ref: '#/components/schemas/Assignment' }, + errors: { title: 'Errors', type: 'array', items: { $ref: '#/components/schemas/Error' } }, + }, + }, + DispatchTaskRequest: { + title: 'DispatchTaskRequest', + required: ['type', 'request'], + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['dispatch_task_request'], + type: 'string', + description: 'Indicate that this is a task dispatch request', + }, + request: { $ref: '#/components/schemas/TaskRequest' }, + }, + }, + Dispenser: { + title: 'Dispenser', + required: ['guid'], + type: 'object', + properties: { guid: { title: 'Guid', type: 'string' } }, + }, + DispenserHealth: { + title: 'DispenserHealth', + required: ['health_status', 'id_'], + type: 'object', + properties: { + health_status: { title: 'Health Status', maxLength: 255, type: 'string', nullable: true }, + health_message: { title: 'Health Message', type: 'string', nullable: true }, + id_: { title: 'Id ', maxLength: 255, type: 'string' }, + }, + additionalProperties: false, + }, + DispenserState: { + title: 'DispenserState', + required: ['time', 'guid', 'mode', 'request_guid_queue', 'seconds_remaining'], + type: 'object', + properties: { + time: { + title: 'Time', + allOf: [{ $ref: '#/components/schemas/Time' }], + default: { sec: 0, nanosec: 0 }, + }, + guid: { title: 'Guid', type: 'string', default: '' }, + mode: { + title: 'Mode', + maximum: 2147483647.0, + minimum: -2147483648.0, + type: 'integer', + default: 0, + }, + request_guid_queue: { + title: 'Request Guid Queue', + type: 'array', + items: { type: 'string' }, + default: [], + }, + seconds_remaining: { title: 'Seconds Remaining', type: 'number', default: 0 }, + }, + }, + Door: { + title: 'Door', + required: [ + 'name', + 'v1_x', + 'v1_y', + 'v2_x', + 'v2_y', + 'door_type', + 'motion_range', + 'motion_direction', + ], + type: 'object', + properties: { + name: { title: 'Name', type: 'string', default: '' }, + v1_x: { title: 'V1 X', type: 'number', default: 0 }, + v1_y: { title: 'V1 Y', type: 'number', default: 0 }, + v2_x: { title: 'V2 X', type: 'number', default: 0 }, + v2_y: { title: 'V2 Y', type: 'number', default: 0 }, + door_type: { + title: 'Door Type', + maximum: 255.0, + minimum: 0.0, + type: 'integer', + default: 0, + }, + motion_range: { title: 'Motion Range', type: 'number', default: 0 }, + motion_direction: { + title: 'Motion Direction', + maximum: 2147483647.0, + minimum: -2147483648.0, + type: 'integer', + default: 0, + }, + }, + }, + DoorHealth: { + title: 'DoorHealth', + required: ['health_status', 'id_'], + type: 'object', + properties: { + health_status: { title: 'Health Status', maxLength: 255, type: 'string', nullable: true }, + health_message: { title: 'Health Message', type: 'string', nullable: true }, + id_: { title: 'Id ', maxLength: 255, type: 'string' }, + }, + additionalProperties: false, + }, + DoorMode: { + title: 'DoorMode', + required: ['value'], + type: 'object', + properties: { + value: { + title: 'Value', + maximum: 4294967295.0, + minimum: 0.0, + type: 'integer', + default: 0, + }, + }, + }, + DoorRequest: { + title: 'DoorRequest', + required: ['mode'], + type: 'object', + properties: { + mode: { + title: 'Mode', + type: 'integer', + description: + 'https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_door_msgs/msg/DoorMode.msg', + }, + }, + }, + DoorState: { + title: 'DoorState', + required: ['door_time', 'door_name', 'current_mode'], + type: 'object', + properties: { + door_time: { + title: 'Door Time', + allOf: [{ $ref: '#/components/schemas/Time' }], + default: { sec: 0, nanosec: 0 }, + }, + door_name: { title: 'Door Name', type: 'string', default: '' }, + current_mode: { + title: 'Current Mode', + allOf: [{ $ref: '#/components/schemas/DoorMode' }], + default: { value: 0 }, + }, + }, + }, + Error: { + title: 'Error', + type: 'object', + properties: { + code: { + title: 'Code', + minimum: 0.0, + type: 'integer', + description: 'A standard code for the kind of error that has occurred', + }, + category: { title: 'Category', type: 'string', description: 'The category of the error' }, + detail: { title: 'Detail', type: 'string', description: 'Details about the error' }, + }, + }, + EstimateMillis: { + title: 'EstimateMillis', + minimum: 0.0, + type: 'integer', + description: 'An estimate, in milliseconds, of how long the subject will take to complete', + }, + EventState: { + title: 'EventState', + required: ['id'], + type: 'object', + properties: { + id: { $ref: '#/components/schemas/Id' }, + status: { $ref: '#/components/schemas/Status' }, + name: { title: 'Name', type: 'string', description: 'The brief name of the event' }, + detail: { + title: 'Detail', + allOf: [{ $ref: '#/components/schemas/Detail' }], + description: 'Detailed information about the event', + }, + deps: { + title: 'Deps', + type: 'array', + items: { type: 'integer', minimum: 0 }, + description: + 'This event may depend on other events. This array contains the IDs of those other event dependencies.', + }, + }, + }, + FleetLog: { + title: 'FleetLog', + type: 'object', + properties: { + name: { title: 'Name', type: 'string' }, + log: { + title: 'Log', + type: 'array', + items: { $ref: '#/components/schemas/LogEntry' }, + description: 'Log for the overall fleet', + }, + robots: { + title: 'Robots', + type: 'object', + additionalProperties: { + type: 'array', + items: { $ref: '#/components/schemas/LogEntry' }, + }, + description: + 'Dictionary of logs for the individual robots. The keys (property names) are the robot names.', + }, + }, + }, + FleetState: { + title: 'FleetState', + type: 'object', + properties: { + name: { title: 'Name', type: 'string' }, + robots: { + title: 'Robots', + type: 'object', + additionalProperties: { $ref: '#/components/schemas/RobotState' }, + description: 'A dictionary of the states of the robots that belong to this fleet', + }, + }, + }, + Graph: { + title: 'Graph', + required: ['name', 'vertices', 'edges', 'params'], + type: 'object', + properties: { + name: { title: 'Name', type: 'string', default: '' }, + vertices: { + title: 'Vertices', + type: 'array', + items: { $ref: '#/components/schemas/GraphNode' }, + default: [], + }, + edges: { + title: 'Edges', + type: 'array', + items: { $ref: '#/components/schemas/GraphEdge' }, + default: [], + }, + params: { + title: 'Params', + type: 'array', + items: { $ref: '#/components/schemas/Param' }, + default: [], + }, + }, + }, + GraphEdge: { + title: 'GraphEdge', + required: ['v1_idx', 'v2_idx', 'params', 'edge_type'], + type: 'object', + properties: { + v1_idx: { + title: 'V1 Idx', + maximum: 4294967295.0, + minimum: 0.0, + type: 'integer', + default: 0, + }, + v2_idx: { + title: 'V2 Idx', + maximum: 4294967295.0, + minimum: 0.0, + type: 'integer', + default: 0, + }, + params: { + title: 'Params', + type: 'array', + items: { $ref: '#/components/schemas/Param' }, + default: [], + }, + edge_type: { + title: 'Edge Type', + maximum: 255.0, + minimum: 0.0, + type: 'integer', + default: 0, + }, + }, + }, + GraphNode: { + title: 'GraphNode', + required: ['x', 'y', 'name', 'params'], + type: 'object', + properties: { + x: { title: 'X', type: 'number', default: 0 }, + y: { title: 'Y', type: 'number', default: 0 }, + name: { title: 'Name', type: 'string', default: '' }, + params: { + title: 'Params', + type: 'array', + items: { $ref: '#/components/schemas/Param' }, + default: [], + }, + }, + }, + HTTPValidationError: { + title: 'HTTPValidationError', + type: 'object', + properties: { + detail: { + title: 'Detail', + type: 'array', + items: { $ref: '#/components/schemas/ValidationError' }, + }, + }, + }, + Id: { title: 'Id', minimum: 0.0, type: 'integer' }, + Ingestor: { + title: 'Ingestor', + required: ['guid'], + type: 'object', + properties: { guid: { title: 'Guid', type: 'string' } }, + }, + IngestorHealth: { + title: 'IngestorHealth', + required: ['health_status', 'id_'], + type: 'object', + properties: { + health_status: { title: 'Health Status', maxLength: 255, type: 'string', nullable: true }, + health_message: { title: 'Health Message', type: 'string', nullable: true }, + id_: { title: 'Id ', maxLength: 255, type: 'string' }, + }, + additionalProperties: false, + }, + IngestorState: { + title: 'IngestorState', + required: ['time', 'guid', 'mode', 'request_guid_queue', 'seconds_remaining'], + type: 'object', + properties: { + time: { + title: 'Time', + allOf: [{ $ref: '#/components/schemas/Time' }], + default: { sec: 0, nanosec: 0 }, + }, + guid: { title: 'Guid', type: 'string', default: '' }, + mode: { + title: 'Mode', + maximum: 2147483647.0, + minimum: -2147483648.0, + type: 'integer', + default: 0, + }, + request_guid_queue: { + title: 'Request Guid Queue', + type: 'array', + items: { type: 'string' }, + default: [], + }, + seconds_remaining: { title: 'Seconds Remaining', type: 'number', default: 0 }, + }, + }, + Interruption: { + title: 'Interruption', + required: ['unix_millis_request_time', 'labels'], + type: 'object', + properties: { + unix_millis_request_time: { + title: 'Unix Millis Request Time', + type: 'integer', + description: 'The time that the interruption request arrived', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the purpose of the interruption', + }, + resumed_by: { + title: 'Resumed By', + allOf: [{ $ref: '#/components/schemas/ResumedBy' }], + description: + 'Information about the resume request that ended this interruption. This field will be missing if the interruption is still active.', + }, + }, + }, + Issue: { + title: 'Issue', + type: 'object', + properties: { + category: { + title: 'Category', + type: 'string', + description: "Category of the robot's issue", + }, + detail: { + title: 'Detail', + anyOf: [{ type: 'object' }, { type: 'array', items: {} }, { type: 'string' }], + description: 'Detailed information about the issue', + }, + }, + }, + Killed: { + title: 'Killed', + required: ['unix_millis_request_time', 'labels'], + type: 'object', + properties: { + unix_millis_request_time: { + title: 'Unix Millis Request Time', + type: 'integer', + description: 'The time that the cancellation request arrived', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the kill request', + }, + }, + }, + Level: { + title: 'Level', + required: ['name', 'elevation', 'images', 'places', 'doors', 'nav_graphs', 'wall_graph'], + type: 'object', + properties: { + name: { title: 'Name', type: 'string', default: '' }, + elevation: { title: 'Elevation', type: 'number', default: 0 }, + images: { + title: 'Images', + type: 'array', + items: { $ref: '#/components/schemas/AffineImage' }, + }, + places: { + title: 'Places', + type: 'array', + items: { $ref: '#/components/schemas/Place' }, + default: [], + }, + doors: { + title: 'Doors', + type: 'array', + items: { $ref: '#/components/schemas/Door' }, + default: [], + }, + nav_graphs: { + title: 'Nav Graphs', + type: 'array', + items: { $ref: '#/components/schemas/Graph' }, + default: [], + }, + wall_graph: { + title: 'Wall Graph', + allOf: [{ $ref: '#/components/schemas/Graph' }], + default: { name: '', vertices: [], edges: [], params: [] }, + }, + }, + }, + Lift: { + title: 'Lift', + required: [ + 'name', + 'levels', + 'doors', + 'wall_graph', + 'ref_x', + 'ref_y', + 'ref_yaw', + 'width', + 'depth', + ], + type: 'object', + properties: { + name: { title: 'Name', type: 'string', default: '' }, + levels: { title: 'Levels', type: 'array', items: { type: 'string' }, default: [] }, + doors: { + title: 'Doors', + type: 'array', + items: { $ref: '#/components/schemas/Door' }, + default: [], + }, + wall_graph: { + title: 'Wall Graph', + allOf: [{ $ref: '#/components/schemas/Graph' }], + default: { name: '', vertices: [], edges: [], params: [] }, + }, + ref_x: { title: 'Ref X', type: 'number', default: 0 }, + ref_y: { title: 'Ref Y', type: 'number', default: 0 }, + ref_yaw: { title: 'Ref Yaw', type: 'number', default: 0 }, + width: { title: 'Width', type: 'number', default: 0 }, + depth: { title: 'Depth', type: 'number', default: 0 }, + }, + }, + LiftHealth: { + title: 'LiftHealth', + required: ['health_status', 'id_'], + type: 'object', + properties: { + health_status: { title: 'Health Status', maxLength: 255, type: 'string', nullable: true }, + health_message: { title: 'Health Message', type: 'string', nullable: true }, + id_: { title: 'Id ', maxLength: 255, type: 'string' }, + }, + additionalProperties: false, + }, + LiftRequest: { + title: 'LiftRequest', + required: ['request_type', 'door_mode', 'destination'], + type: 'object', + properties: { + request_type: { + title: 'Request Type', + type: 'integer', + description: + 'https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_lift_msgs/msg/LiftRequest.msg', + }, + door_mode: { + title: 'Door Mode', + type: 'integer', + description: + 'https://github.com/open-rmf/rmf_internal_msgs/blob/main/rmf_lift_msgs/msg/LiftRequest.msg', + }, + destination: { title: 'Destination', type: 'string' }, + }, + }, + LiftState: { + title: 'LiftState', + required: [ + 'lift_time', + 'lift_name', + 'available_floors', + 'current_floor', + 'destination_floor', + 'door_state', + 'motion_state', + 'available_modes', + 'current_mode', + 'session_id', + ], + type: 'object', + properties: { + lift_time: { + title: 'Lift Time', + allOf: [{ $ref: '#/components/schemas/Time' }], + default: { sec: 0, nanosec: 0 }, + }, + lift_name: { title: 'Lift Name', type: 'string', default: '' }, + available_floors: { + title: 'Available Floors', + type: 'array', + items: { type: 'string' }, + default: [], + }, + current_floor: { title: 'Current Floor', type: 'string', default: '' }, + destination_floor: { title: 'Destination Floor', type: 'string', default: '' }, + door_state: { + title: 'Door State', + maximum: 255.0, + minimum: 0.0, + type: 'integer', + default: 0, + }, + motion_state: { + title: 'Motion State', + maximum: 255.0, + minimum: 0.0, + type: 'integer', + default: 0, + }, + available_modes: { title: 'Available Modes', type: 'array', items: { type: 'integer' } }, + current_mode: { + title: 'Current Mode', + maximum: 255.0, + minimum: 0.0, + type: 'integer', + default: 0, + }, + session_id: { title: 'Session Id', type: 'string', default: '' }, + }, + }, + Location2D: { + title: 'Location2D', + required: ['map', 'x', 'y', 'yaw'], + type: 'object', + properties: { + map: { title: 'Map', type: 'string' }, + x: { title: 'X', type: 'number' }, + y: { title: 'Y', type: 'number' }, + yaw: { title: 'Yaw', type: 'number' }, + }, + }, + LogEntry: { + title: 'LogEntry', + required: ['seq', 'tier', 'unix_millis_time', 'text'], + type: 'object', + properties: { + seq: { + title: 'Seq', + exclusiveMaximum: 4294967296.0, + minimum: 0.0, + type: 'integer', + description: + 'Sequence number for this entry. Each entry has a unique sequence number which monotonically increase, until integer overflow causes a wrap around.', + }, + tier: { + allOf: [{ $ref: '#/components/schemas/Tier' }], + description: 'The importance level of the log entry', + }, + unix_millis_time: { title: 'Unix Millis Time', type: 'integer' }, + text: { title: 'Text', type: 'string', description: 'The text of the log entry' }, + }, + }, + Param: { + title: 'Param', + required: ['name', 'type', 'value_int', 'value_float', 'value_string', 'value_bool'], + type: 'object', + properties: { + name: { title: 'Name', type: 'string', default: '' }, + type: { title: 'Type', maximum: 4294967295.0, minimum: 0.0, type: 'integer', default: 0 }, + value_int: { + title: 'Value Int', + maximum: 2147483647.0, + minimum: -2147483648.0, + type: 'integer', + default: 0, + }, + value_float: { title: 'Value Float', type: 'number', default: 0 }, + value_string: { title: 'Value String', type: 'string', default: '' }, + value_bool: { title: 'Value Bool', type: 'boolean', default: false }, + }, + }, + Permission: { + title: 'Permission', + required: ['authz_grp', 'action'], + type: 'object', + properties: { + authz_grp: { title: 'Authz Grp', type: 'string' }, + action: { title: 'Action', type: 'string' }, + }, + }, + Phase: { + title: 'Phase', + required: ['id'], + type: 'object', + properties: { + id: { $ref: '#/components/schemas/Id' }, + category: { $ref: '#/components/schemas/Category' }, + detail: { $ref: '#/components/schemas/Detail' }, + unix_millis_start_time: { title: 'Unix Millis Start Time', type: 'integer' }, + unix_millis_finish_time: { title: 'Unix Millis Finish Time', type: 'integer' }, + original_estimate_millis: { $ref: '#/components/schemas/EstimateMillis' }, + estimate_millis: { $ref: '#/components/schemas/EstimateMillis' }, + final_event_id: { $ref: '#/components/schemas/Id' }, + events: { + title: 'Events', + type: 'object', + additionalProperties: { $ref: '#/components/schemas/EventState' }, + description: + 'A dictionary of events for this phase. The keys (property names) are the event IDs, which are integers.', + }, + skip_requests: { + title: 'Skip Requests', + type: 'object', + additionalProperties: { $ref: '#/components/schemas/SkipPhaseRequest' }, + description: 'Information about any skip requests that have been received', + }, + }, + }, + Phases: { + title: 'Phases', + type: 'object', + properties: { + log: { + title: 'Log', + type: 'array', + items: { $ref: '#/components/schemas/LogEntry' }, + description: 'Log entries related to the overall phase', + }, + events: { + title: 'Events', + type: 'object', + additionalProperties: { + type: 'array', + items: { $ref: '#/components/schemas/LogEntry' }, + }, + description: + 'A dictionary whose keys (property names) are the indices of an event in the phase', + }, + }, + additionalProperties: false, + }, + Place: { + title: 'Place', + required: ['name', 'x', 'y', 'yaw', 'position_tolerance', 'yaw_tolerance'], + type: 'object', + properties: { + name: { title: 'Name', type: 'string', default: '' }, + x: { title: 'X', type: 'number', default: 0 }, + y: { title: 'Y', type: 'number', default: 0 }, + yaw: { title: 'Yaw', type: 'number', default: 0 }, + position_tolerance: { title: 'Position Tolerance', type: 'number', default: 0 }, + yaw_tolerance: { title: 'Yaw Tolerance', type: 'number', default: 0 }, + }, + }, + PostMakeAdmin: { + title: 'PostMakeAdmin', + required: ['admin'], + type: 'object', + properties: { admin: { title: 'Admin', type: 'boolean' } }, + }, + PostRoles: { + title: 'PostRoles', + required: ['name'], + type: 'object', + properties: { name: { title: 'Name', type: 'string' } }, + }, + PostUsers: { + title: 'PostUsers', + required: ['username'], + type: 'object', + properties: { + username: { title: 'Username', type: 'string' }, + is_admin: { title: 'Is Admin', type: 'boolean', default: false }, + }, + }, + ResumedBy: { + title: 'ResumedBy', + required: ['labels'], + type: 'object', + properties: { + unix_millis_request_time: { + title: 'Unix Millis Request Time', + type: 'integer', + description: 'The time that the resume request arrived', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the resume request', + }, + }, + }, + RobotState: { + title: 'RobotState', + type: 'object', + properties: { + name: { title: 'Name', type: 'string' }, + status: { + allOf: [{ $ref: '#/components/schemas/Status2' }], + description: 'A simple token representing the status of the robot', + }, + task_id: { + title: 'Task Id', + type: 'string', + description: + 'The ID of the task this robot is currently working on. Empty string if the robot is not working on a task.', + }, + unix_millis_time: { title: 'Unix Millis Time', type: 'integer' }, + location: { $ref: '#/components/schemas/Location2D' }, + battery: { + title: 'Battery', + maximum: 1.0, + minimum: 0.0, + type: 'number', + description: + 'State of charge of the battery. Values range from 0.0 (depleted) to 1.0 (fully charged)', + }, + issues: { + title: 'Issues', + type: 'array', + items: { $ref: '#/components/schemas/Issue' }, + description: 'A list of issues with the robot that operators need to address', + }, + }, + }, + SimpleResponse: { + title: 'SimpleResponse', + anyOf: [ + { $ref: '#/components/schemas/SimpleResponseItem' }, + { $ref: '#/components/schemas/SimpleResponseItem1' }, + ], + description: + 'Template for defining a response message that only indicates success and describes any errors', + }, + SimpleResponseItem: { + title: 'SimpleResponseItem', + required: ['success'], + type: 'object', + properties: { + success: { + $ref: '#/components/schemas/api_server__models__rmf_api__simple_response__Success', + }, + }, + }, + SimpleResponseItem1: { + title: 'SimpleResponseItem1', + required: ['success', 'errors'], + type: 'object', + properties: { + success: { + $ref: '#/components/schemas/api_server__models__rmf_api__simple_response__Failure', + }, + errors: { + title: 'Errors', + type: 'array', + items: { $ref: '#/components/schemas/Error' }, + description: 'If the request failed, these error messages will explain why', + }, + }, + }, + SkipPhaseRequest: { + title: 'SkipPhaseRequest', + required: ['unix_millis_request_time', 'labels'], + type: 'object', + properties: { + unix_millis_request_time: { + title: 'Unix Millis Request Time', + type: 'integer', + description: 'The time that the skip request arrived', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the purpose of the skip request', + }, + undo: { + title: 'Undo', + allOf: [{ $ref: '#/components/schemas/Undo' }], + description: 'Information about an undo skip request that applied to this request', + }, + }, + }, + SkipPhaseResponse: { + title: 'SkipPhaseResponse', + allOf: [{ $ref: '#/components/schemas/TokenResponse' }], + description: 'Response to a request for a phase to be skipped', + }, + Status: { + title: 'Status', + enum: [ + 'uninitialized', + 'blocked', + 'error', + 'failed', + 'queued', + 'standby', + 'underway', + 'delayed', + 'skipped', + 'canceled', + 'killed', + 'completed', + ], + description: 'An enumeration.', + }, + Status1: { + title: 'Status1', + enum: ['queued', 'selected', 'dispatched', 'failed_to_assign', 'canceled_in_flight'], + description: 'An enumeration.', + }, + Status2: { + title: 'Status2', + enum: ['uninitialized', 'offline', 'shutdown', 'idle', 'charging', 'working', 'error'], + description: 'An enumeration.', + }, + Task: { + title: 'Task', + required: ['category', 'detail'], + type: 'object', + properties: { + category: { + title: 'Category', + type: 'string', + description: + 'The category of this task. There must not be any duplicate task categories per fleet.', + }, + detail: { + title: 'Detail', + type: 'string', + description: 'Details about the behavior of the task.', + }, + description_schema: { + title: 'Description Schema', + type: 'object', + description: 'The schema for this task description', + }, + }, + }, + TaskCancelResponse: { + title: 'TaskCancelResponse', + allOf: [{ $ref: '#/components/schemas/SimpleResponse' }], + description: 'Response to a request to cancel a task', + }, + TaskDiscovery: { + title: 'TaskDiscovery', + required: ['type', 'data'], + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['task_discovery_update'], + type: 'string', + description: 'Indicate that this is an task discovery update', + }, + data: { $ref: '#/components/schemas/Data' }, + }, + }, + TaskDiscoveryRequest: { + title: 'TaskDiscoveryRequest', + required: ['type'], + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['task_discovery_request'], + type: 'string', + description: 'Indicate that this is a task discovery request', + }, + }, + }, + TaskDispatchResponseItem: { + title: 'TaskDispatchResponseItem', + required: ['success', 'state'], + type: 'object', + properties: { + success: { title: 'Success', enum: [true], type: 'boolean' }, + state: { $ref: '#/components/schemas/TaskState' }, + }, + }, + TaskDispatchResponseItem1: { + title: 'TaskDispatchResponseItem1', + type: 'object', + properties: { + success: { title: 'Success', enum: [false], type: 'boolean' }, + errors: { + title: 'Errors', + type: 'array', + items: { $ref: '#/components/schemas/Error' }, + description: 'Any error messages explaining why the request failed', + }, + }, + }, + TaskEventLog: { + title: 'TaskEventLog', + required: ['task_id'], + type: 'object', + properties: { + task_id: { title: 'Task Id', type: 'string' }, + log: { + title: 'Log', + type: 'array', + items: { $ref: '#/components/schemas/LogEntry' }, + description: 'Log entries related to the overall task', + }, + phases: { + title: 'Phases', + type: 'object', + additionalProperties: { $ref: '#/components/schemas/Phases' }, + description: 'A dictionary whose keys (property names) are the indices of a phase', + }, + }, + additionalProperties: false, + }, + TaskInterruptionRequest: { + title: 'TaskInterruptionRequest', + required: ['type', 'task_id'], + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['interrupt_task_request'], + type: 'string', + description: 'Indicate that this is a task interruption request', + }, + task_id: { + title: 'Task Id', + type: 'string', + description: 'Specify the task ID to interrupt', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the purpose of the interruption', + }, + }, + }, + TaskInterruptionResponse: { + title: 'TaskInterruptionResponse', + allOf: [{ $ref: '#/components/schemas/TokenResponse' }], + description: 'Response to a request for a task to be interrupted', + }, + TaskKillRequest: { + title: 'TaskKillRequest', + required: ['type', 'task_id'], + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['kill_task_request'], + type: 'string', + description: 'Indicate that this is a task kill request', + }, + task_id: { title: 'Task Id', type: 'string', description: 'Specify the task ID to kill' }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the purpose of the kill', + }, + }, + }, + TaskKillResponse: { + title: 'TaskKillResponse', + allOf: [{ $ref: '#/components/schemas/SimpleResponse' }], + description: 'Response to a request to kill a task', + }, + TaskPhaseSkipRequest: { + title: 'TaskPhaseSkipRequest', + required: ['type', 'task_id', 'phase_id'], + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['skip_phase_request'], + type: 'string', + description: 'Indicate that this is a phase skip request', + }, + task_id: { + title: 'Task Id', + type: 'string', + description: 'Specify the task ID whose phase should be skipped', + }, + phase_id: { + title: 'Phase Id', + minimum: 0.0, + type: 'integer', + description: 'Specify the phase that should be skipped', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the purpose of the skip', + }, + }, + }, + TaskRequest: { + title: 'TaskRequest', + required: ['category', 'description'], + type: 'object', + properties: { + unix_millis_earliest_start_time: { + title: 'Unix Millis Earliest Start Time', + type: 'integer', + description: '(Optional) The earliest time that this task may start', + }, + priority: { + title: 'Priority', + type: 'object', + description: + '(Optional) The priority of this task. This must match a priority schema supported by a fleet.', + }, + category: { title: 'Category', type: 'string' }, + description: { + title: 'Description', + description: + 'A description of the task. This must match a schema supported by a fleet for the category of this task request.', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the purpose of the task dispatch request', + }, + }, + }, + TaskResumeRequest: { + title: 'TaskResumeRequest', + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['resume_task_request'], + type: 'string', + description: 'Indicate that this is a task resuming request', + }, + for_task: { + title: 'For Task', + type: 'string', + description: 'Specify task ID to resume.', + }, + for_tokens: { + title: 'For Tokens', + minItems: 1, + type: 'array', + items: { type: 'string' }, + description: + 'A list of tokens of interruption requests which should be resumed. The interruption request associated with each token will be discarded.', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels describing this request', + }, + }, + }, + TaskResumeResponse: { + title: 'TaskResumeResponse', + allOf: [{ $ref: '#/components/schemas/SimpleResponse' }], + description: 'Response to a request to resume a task', + }, + TaskRewindRequest: { + title: 'TaskRewindRequest', + required: ['type', 'task_id', 'phase_id'], + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['rewind_task_request'], + type: 'string', + description: 'Indicate that this is a task rewind request', + }, + task_id: { + title: 'Task Id', + type: 'string', + description: 'Specify the ID of the task that should rewind', + }, + phase_id: { + title: 'Phase Id', + minimum: 0.0, + type: 'integer', + description: + 'Specify the phase that should be rewound to. The task will restart at the beginning of this phase.', + }, + }, + }, + TaskRewindResponse: { + title: 'TaskRewindResponse', + allOf: [{ $ref: '#/components/schemas/SimpleResponse' }], + description: 'Response to a request to rewind a task', + }, + TaskState: { + title: 'TaskState', + required: ['booking'], + type: 'object', + properties: { + booking: { $ref: '#/components/schemas/Booking' }, + category: { $ref: '#/components/schemas/Category' }, + detail: { $ref: '#/components/schemas/Detail' }, + unix_millis_start_time: { title: 'Unix Millis Start Time', type: 'integer' }, + unix_millis_finish_time: { title: 'Unix Millis Finish Time', type: 'integer' }, + original_estimate_millis: { $ref: '#/components/schemas/EstimateMillis' }, + estimate_millis: { $ref: '#/components/schemas/EstimateMillis' }, + assigned_to: { + title: 'Assigned To', + allOf: [{ $ref: '#/components/schemas/AssignedTo' }], + description: 'Which agent (robot) is the task assigned to', + }, + status: { $ref: '#/components/schemas/Status' }, + dispatch: { $ref: '#/components/schemas/Dispatch' }, + phases: { + title: 'Phases', + type: 'object', + additionalProperties: { $ref: '#/components/schemas/Phase' }, + description: + 'A dictionary of the states of the phases of the task. The keys (property names) are phase IDs, which are integers.', + }, + completed: { + title: 'Completed', + type: 'array', + items: { $ref: '#/components/schemas/Id' }, + description: 'An array of the IDs of completed phases of this task', + }, + active: { + title: 'Active', + allOf: [{ $ref: '#/components/schemas/Id' }], + description: 'The ID of the active phase for this task', + }, + pending: { + title: 'Pending', + type: 'array', + items: { $ref: '#/components/schemas/Id' }, + description: 'An array of the pending phases of this task', + }, + interruptions: { + title: 'Interruptions', + type: 'object', + additionalProperties: { $ref: '#/components/schemas/Interruption' }, + description: + 'A dictionary of interruptions that have been applied to this task. The keys (property names) are the unique token of the interruption request.', + }, + cancellation: { + title: 'Cancellation', + allOf: [{ $ref: '#/components/schemas/Cancellation' }], + description: + 'If the task was cancelled, this will describe information about the request.', + }, + killed: { + title: 'Killed', + allOf: [{ $ref: '#/components/schemas/Killed' }], + description: + 'If the task was killed, this will describe information about the request.', + }, + }, + }, + Tier: { + title: 'Tier', + enum: ['uninitialized', 'info', 'warning', 'error'], + description: 'An enumeration.', + }, + Time: { + title: 'Time', + required: ['sec', 'nanosec'], + type: 'object', + properties: { + sec: { + title: 'Sec', + maximum: 2147483647.0, + minimum: -2147483648.0, + type: 'integer', + default: 0, + }, + nanosec: { + title: 'Nanosec', + maximum: 4294967295.0, + minimum: 0.0, + type: 'integer', + default: 0, + }, + }, + }, + TokenResponse: { + title: 'TokenResponse', + anyOf: [ + { $ref: '#/components/schemas/TokenResponseItem' }, + { $ref: '#/components/schemas/TokenResponseItem1' }, + ], + description: + 'Template for defining a response message that provides a token upon success or errors upon failure', + }, + TokenResponseItem: { + title: 'TokenResponseItem', + required: ['success', 'token'], + type: 'object', + properties: { + success: { + $ref: '#/components/schemas/api_server__models__rmf_api__token_response__Success', + }, + token: { + title: 'Token', + type: 'string', + description: + 'A token for the request. The value of this token is unique within the scope of this request and can be used by other requests to reference this request.', + }, + }, + }, + TokenResponseItem1: { + title: 'TokenResponseItem1', + required: ['success', 'errors'], + type: 'object', + properties: { + success: { + $ref: '#/components/schemas/api_server__models__rmf_api__token_response__Failure', + }, + errors: { + title: 'Errors', + type: 'array', + items: { $ref: '#/components/schemas/Error' }, + description: 'Any error messages explaining why the request failed.', + }, + }, + }, + Undo: { + title: 'Undo', + required: ['unix_millis_request_time', 'labels'], + type: 'object', + properties: { + unix_millis_request_time: { + title: 'Unix Millis Request Time', + type: 'integer', + description: 'The time that the undo skip request arrived', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels to describe the undo skip request', + }, + }, + }, + UndoPhaseSkipRequest: { + title: 'UndoPhaseSkipRequest', + type: 'object', + properties: { + type: { + title: 'Type', + enum: ['undo_phase_skip_request'], + type: 'string', + description: 'Indicate that this is a request to undo a phase skip request', + }, + for_task: { + title: 'For Task', + type: 'string', + description: 'Specify the relevant task ID', + }, + for_tokens: { + title: 'For Tokens', + minItems: 1, + type: 'array', + items: { type: 'string' }, + description: + 'A list of the tokens of skip requests which should be undone. The skips associated with each token will be discarded.', + }, + labels: { + title: 'Labels', + type: 'array', + items: { type: 'string' }, + description: 'Labels describing this request', + }, + }, + }, + UndoPhaseSkipResponse: { + title: 'UndoPhaseSkipResponse', + allOf: [{ $ref: '#/components/schemas/SimpleResponse' }], + description: 'Response to an undo phase skip request', + }, + User: { + title: 'User', + required: ['username', 'is_admin', 'roles'], + type: 'object', + properties: { + username: { title: 'Username', type: 'string' }, + is_admin: { title: 'Is Admin', type: 'boolean', default: false }, + roles: { title: 'Roles', type: 'array', items: { type: 'string' }, default: [] }, + }, + }, + ValidationError: { + title: 'ValidationError', + required: ['loc', 'msg', 'type'], + type: 'object', + properties: { + loc: { title: 'Location', type: 'array', items: { type: 'string' } }, + msg: { title: 'Message', type: 'string' }, + type: { title: 'Error Type', type: 'string' }, + }, + }, + api_server__models__rmf_api__simple_response__Failure: { + title: 'Failure', + enum: [false], + description: 'An enumeration.', + }, + api_server__models__rmf_api__simple_response__Success: { + title: 'Success', + enum: [true], + description: 'An enumeration.', + }, + api_server__models__rmf_api__token_response__Failure: { + title: 'Failure', + enum: [false], + description: 'An enumeration.', + }, + api_server__models__rmf_api__token_response__Success: { + title: 'Success', + enum: [true], + description: 'An enumeration.', + }, + }, + }, +}; diff --git a/packages/api-client/openapi/schema/package.json b/packages/api-client/openapi/schema/package.json new file mode 100644 index 000000000..e6d6748e7 --- /dev/null +++ b/packages/api-client/openapi/schema/package.json @@ -0,0 +1,3 @@ +{ + "main": "../../../dist/lib/schema/index.js" +} diff --git a/packages/api-client/package.json b/packages/api-client/package.json index de81ebe93..26197b4bd 100644 --- a/packages/api-client/package.json +++ b/packages/api-client/package.json @@ -32,6 +32,7 @@ "axios": "^0.21.1" }, "files": [ - "dist/" + "dist/", + "openapi/schema/" ] } From a1286090d3f8d7abbf3c86b3a4bb058d6d7f8b65 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 21 Feb 2022 15:47:10 +0800 Subject: [PATCH 75/79] use ajv to validate input file Signed-off-by: Teo Koon Peng --- package-lock.json | 58 ++++++++++--- .../api-client/openapi/schema/package.json | 2 +- packages/dashboard/package.json | 3 + .../src/components/tasks/task-panel.tsx | 70 +++++++-------- .../dashboard/src/components/tasks/utils.ts | 87 +++++-------------- 5 files changed, 106 insertions(+), 114 deletions(-) diff --git a/package-lock.json b/package-lock.json index 7cd7b207e..90414e597 100644 --- a/package-lock.json +++ b/package-lock.json @@ -20485,8 +20485,7 @@ "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" }, "node_modules/fast-glob": { "version": "3.2.7", @@ -33874,7 +33873,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", - "dev": true, "engines": { "node": ">=0.10.0" } @@ -38938,7 +38936,6 @@ "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "dev": true, "dependencies": { "punycode": "^2.1.0" } @@ -38947,7 +38944,6 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", - "dev": true, "engines": { "node": ">=6" } @@ -42092,6 +42088,9 @@ "packages/dashboard": { "name": "rmf-dashboard", "version": "0.0.1", + "dependencies": { + "ajv": "^8.10.0" + }, "devDependencies": { "@emotion/react": "^11.4.1", "@emotion/styled": "^11.3.0", @@ -42161,6 +42160,26 @@ "typescript": "~4.4.4" } }, + "packages/dashboard/node_modules/ajv": { + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.10.0.tgz", + "integrity": "sha512-bzqAEZOjkrUMl2afH8dknrq5KEk2SrwdBROR+vH1EKVQTqaUbJVPdc/gEdggTMM0Se+s+Ja4ju4TlNcStKl2Hw==", + "dependencies": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "packages/dashboard/node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==" + }, "packages/react-components": { "version": "0.0.1", "license": "Apache-2.0", @@ -58213,8 +58232,7 @@ "fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", - "dev": true + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" }, "fast-glob": { "version": "3.2.7", @@ -68951,8 +68969,7 @@ "require-from-string": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", - "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", - "dev": true + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==" }, "require-main-filename": { "version": "2.0.0", @@ -69377,6 +69394,7 @@ "@types/react-router": "^5.1.7", "@types/react-router-dom": "^5.1.7", "@types/reactour": "^1.17.1", + "ajv": "*", "api-client": "file:../api-client", "api-server": "file:../api-server", "axios": "^0.21.1", @@ -69403,6 +69421,24 @@ "styled-components": "^4.4.1", "ts-node": "^9.1.1", "typescript": "~4.4.4" + }, + "dependencies": { + "ajv": { + "version": "8.10.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.10.0.tgz", + "integrity": "sha512-bzqAEZOjkrUMl2afH8dknrq5KEk2SrwdBROR+vH1EKVQTqaUbJVPdc/gEdggTMM0Se+s+Ja4ju4TlNcStKl2Hw==", + "requires": { + "fast-deep-equal": "^3.1.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.2.2" + } + }, + "json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==" + } } }, "rmf-dashboard-e2e": { @@ -73158,7 +73194,6 @@ "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", - "dev": true, "requires": { "punycode": "^2.1.0" }, @@ -73166,8 +73201,7 @@ "punycode": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.1.1.tgz", - "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==", - "dev": true + "integrity": "sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==" } } }, diff --git a/packages/api-client/openapi/schema/package.json b/packages/api-client/openapi/schema/package.json index e6d6748e7..64b4e5b8c 100644 --- a/packages/api-client/openapi/schema/package.json +++ b/packages/api-client/openapi/schema/package.json @@ -1,3 +1,3 @@ { - "main": "../../../dist/lib/schema/index.js" + "main": "../../dist/lib/schema/index.js" } diff --git a/packages/dashboard/package.json b/packages/dashboard/package.json index 09722166b..167a34a39 100644 --- a/packages/dashboard/package.json +++ b/packages/dashboard/package.json @@ -99,5 +99,8 @@ "!**/stories/**", "!**/tests/**" ] + }, + "dependencies": { + "ajv": "^8.10.0" } } diff --git a/packages/dashboard/src/components/tasks/task-panel.tsx b/packages/dashboard/src/components/tasks/task-panel.tsx index 564294c90..1ca4a7067 100644 --- a/packages/dashboard/src/components/tasks/task-panel.tsx +++ b/packages/dashboard/src/components/tasks/task-panel.tsx @@ -19,15 +19,15 @@ import { Typography, useTheme, } from '@mui/material'; -import { TaskEventLog, TaskState } from 'api-client'; +import { DispatchTaskRequest, TaskEventLog, TaskState } from 'api-client'; import React from 'react'; import { CreateTaskForm, CreateTaskFormProps, TaskInfo, TaskTable } from 'react-components'; import { UserProfileContext } from 'rmf-auth'; -//import { AppControllerContext } from '../app-contexts'; +import { AppControllerContext } from '../app-contexts'; import { Enforcer } from '../permissions'; import { RmfIngressContext } from '../rmf-app'; -//import { parseTasksFile } from './utils'; import { TaskLogs } from './task-logs'; +import { parseTasksFile } from './utils'; const prefix = 'task-panel'; const classes = { @@ -139,7 +139,7 @@ export function TaskPanel({ const [autoRefresh, setAutoRefresh] = React.useState(true); const [selectedTaskLog, setSelectedTaskLog] = React.useState(undefined); const profile = React.useContext(UserProfileContext); - //const { showErrorAlert } = React.useContext(AppControllerContext); + const { showErrorAlert } = React.useContext(AppControllerContext); const { tasksApi } = React.useContext(RmfIngressContext) || {}; const handleCancelTaskClick = React.useCallback(async () => { @@ -160,35 +160,35 @@ export function TaskPanel({ }, [cancelTask, selectedTask]); // /* istanbul ignore next */ - //const tasksFromFile = (): Promise => { - //return new Promise((res) => { - //const fileInputEl = uploadFileInputRef.current; - //if (!fileInputEl) { - //return []; - //} - //let taskFiles: TaskState[]; - //const listener = async () => { - //try { - //if (!fileInputEl.files || fileInputEl.files.length === 0) { - //return res([]); - //} - //try { - //taskFiles = parseTasksFile(await fileInputEl.files[0].text()); - //} catch (err) { - //showErrorAlert((err as Error).message, 5000); - //return res([]); - //} - //// only submit tasks when all tasks are error free - //return res(taskFiles); - //} finally { - //fileInputEl.removeEventListener('input', listener); - //fileInputEl.value = ''; - //} - //}; - //fileInputEl.addEventListener('input', listener); - //fileInputEl.click(); - //}); - //}; + const tasksFromFile = (): Promise => { + return new Promise((res) => { + const fileInputEl = uploadFileInputRef.current; + if (!fileInputEl) { + return []; + } + let taskFiles: DispatchTaskRequest[]; + const listener = async () => { + try { + if (!fileInputEl.files || fileInputEl.files.length === 0) { + return res([]); + } + try { + taskFiles = parseTasksFile(await fileInputEl.files[0].text()); + } catch (err) { + showErrorAlert((err as Error).message, 5000); + return res([]); + } + // only submit tasks when all tasks are error free + return res(taskFiles); + } finally { + fileInputEl.removeEventListener('input', listener); + fileInputEl.value = ''; + } + }; + fileInputEl.addEventListener('input', listener); + fileInputEl.click(); + }); + }; const fetchLogs = React.useCallback(async () => { if (!tasksApi) { @@ -210,7 +210,7 @@ export function TaskPanel({ if (autoRefresh) fetchLogs(); }, RefreshRate); return () => clearInterval(interval); - }, [tasksApi, selectedTask, autoRefresh]); + }, [tasksApi, selectedTask, autoRefresh, fetchLogs]); React.useEffect(() => { fetchLogs(); @@ -314,7 +314,7 @@ export function TaskPanel({ open={openCreateTaskForm} onClose={() => setOpenCreateTaskForm(false)} submitTasks={submitTasks} - // tasksFromFile={tasksFromFile} + tasksFromFile={tasksFromFile} onSuccess={() => { setOpenCreateTaskForm(false); setSnackbarSeverity('success'); diff --git a/packages/dashboard/src/components/tasks/utils.ts b/packages/dashboard/src/components/tasks/utils.ts index ef270741d..6330434d2 100644 --- a/packages/dashboard/src/components/tasks/utils.ts +++ b/packages/dashboard/src/components/tasks/utils.ts @@ -1,75 +1,30 @@ -// import { SubmitTask } from 'api-client'; -import { TaskType as RmfTaskType } from 'rmf-models'; +import Ajv, { ValidateFunction } from 'ajv'; +import { DispatchTaskRequest } from 'api-client'; +import schema from 'api-client/openapi/schema'; -/** - * TODO - handle submit task type changes once the backend connection is available - */ +let validate: ValidateFunction | null = null; -const genericErrors = { - checkArray: 'Expected an array of tasks', - checkTaskObject: 'Expected task to be an object', -}; - -/* istanbul ignore next */ -function checkField( - obj: Record, - field: string, - type: string, - index: number, -): string | void { - if (!Object.prototype.hasOwnProperty.call(obj, field) || typeof obj[field] !== type) { - return `Task ${index + 1}: expected [${field}] to be [${type}]`; +function getValidator() { + if (validate) { + return validate; } + const ajv = new Ajv(); + validate = ajv.compile(schema.components.schemas.DispatchTaskRequest); + return validate; } -// TODO: See if we c>an generate validators from the schema. /* istanbul ignore next */ -export function parseTasksFile(contents: string): any[] { - const errMsgs: (string | void)[] = []; - const tasks = JSON.parse(contents); - if (!Array.isArray(tasks)) { - throw new TypeError(genericErrors.checkArray); +export function parseTasksFile(contents: string): DispatchTaskRequest[] { + const obj = JSON.parse(contents) as unknown[]; + if (!Array.isArray(obj)) { + throw new Error('Expected an array of tasks'); } - tasks.forEach((t, i) => { - if (typeof t !== 'object') { - throw new TypeError(genericErrors.checkTaskObject); - } - checkField(t, 'task_type', 'number', i) && - errMsgs.push(checkField(t, 'task_type', 'number', i)); - checkField(t, 'start_time', 'number', i) && - errMsgs.push(checkField(t, 'start_time', 'number', i)); - checkField(t, 'priority', 'number', i) && errMsgs.push(checkField(t, 'priority', 'number', i)); - checkField(t, 'description', 'object', i) && - errMsgs.push(checkField(t, 'description', 'object', i)); - const desc = t['description']; - switch (t['task_type']) { - case RmfTaskType.TYPE_CLEAN: - checkField(desc, 'cleaning_zone', 'string', i) && - errMsgs.push(checkField(desc, 'cleaning_zone', 'string', i)); - break; - case RmfTaskType.TYPE_DELIVERY: - checkField(desc, 'pickup_place_name', 'string', i) && - errMsgs.push(checkField(desc, 'pickup_place_name', 'string', i)); - checkField(desc, 'pickup_dispenser', 'string', i) && - errMsgs.push(checkField(desc, 'pickup_dispenser', 'string', i)); - checkField(desc, 'dropoff_ingestor', 'string', i) && - errMsgs.push(checkField(desc, 'dropoff_ingestor', 'string', i)); - checkField(desc, 'dropoff_place_name', 'string', i) && - errMsgs.push(checkField(desc, 'dropoff_place_name', 'string', i)); - break; - case RmfTaskType.TYPE_LOOP: - checkField(desc, 'num_loops', 'number', i) && - errMsgs.push(checkField(desc, 'num_loops', 'number', i)); - checkField(desc, 'start_name', 'string', i) && - errMsgs.push(checkField(desc, 'start_name', 'string', i)); - checkField(desc, 'finish_name', 'string', i) && - errMsgs.push(checkField(desc, 'finish_name', 'string', i)); - break; - default: - errMsgs.push(`Task ${i + 1}: Unknown task type`); - } - }); - if (errMsgs.length > 0) throw new Error(errMsgs.join('\n')); - return tasks; + const validate = getValidator(); + const errIdx = obj.findIndex((req) => !validate(req)); + if (errIdx !== -1) { + const errors = validate.errors!; + throw new Error(`Validation error on item ${errIdx + 1}: ${errors[0].message}`); + } + return obj; } From 5d8df0d5d922e42469ffc4bad18232bd43d851cc Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 21 Feb 2022 17:28:21 +0800 Subject: [PATCH 76/79] fix build Signed-off-by: Teo Koon Peng --- packages/api-client/generate-openapi.sh | 2 +- .../api-client/openapi/schema/package.json | 3 --- packages/api-client/package.json | 2 +- .../api-client/{openapi => }/schema/index.ts | 0 packages/api-client/schema/package.json | 3 +++ packages/api-client/tsconfig.json | 2 +- .../src/components/tasks/task-panel.tsx | 6 ++--- .../dashboard/src/components/tasks/utils.ts | 24 +++++-------------- packages/dashboard/src/components/utils.ts | 8 +++++++ 9 files changed, 23 insertions(+), 27 deletions(-) delete mode 100644 packages/api-client/openapi/schema/package.json rename packages/api-client/{openapi => }/schema/index.ts (100%) create mode 100644 packages/api-client/schema/package.json diff --git a/packages/api-client/generate-openapi.sh b/packages/api-client/generate-openapi.sh index 2501e4eb2..fcf566925 100755 --- a/packages/api-client/generate-openapi.sh +++ b/packages/api-client/generate-openapi.sh @@ -45,7 +45,7 @@ EOF npx prettier -w lib # generate schema -cat << EOF > openapi/schema/index.ts +cat << EOF > schema/index.ts export default $(cat build/openapi.json) EOF npx prettier -w openapi/schema diff --git a/packages/api-client/openapi/schema/package.json b/packages/api-client/openapi/schema/package.json deleted file mode 100644 index 64b4e5b8c..000000000 --- a/packages/api-client/openapi/schema/package.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "main": "../../dist/lib/schema/index.js" -} diff --git a/packages/api-client/package.json b/packages/api-client/package.json index 26197b4bd..9854340b7 100644 --- a/packages/api-client/package.json +++ b/packages/api-client/package.json @@ -2,7 +2,7 @@ "name": "api-client", "version": "0.0.1", "description": "", - "main": "dist/lib/index.js", + "main": "./dist/lib/index.js", "scripts": { "build": "../../scripts/nws.sh build -d && tsc --build", "clean": "tsc --build --clean", diff --git a/packages/api-client/openapi/schema/index.ts b/packages/api-client/schema/index.ts similarity index 100% rename from packages/api-client/openapi/schema/index.ts rename to packages/api-client/schema/index.ts diff --git a/packages/api-client/schema/package.json b/packages/api-client/schema/package.json new file mode 100644 index 000000000..582018905 --- /dev/null +++ b/packages/api-client/schema/package.json @@ -0,0 +1,3 @@ +{ + "main": "../dist/openapi/schema.js" +} diff --git a/packages/api-client/tsconfig.json b/packages/api-client/tsconfig.json index 9dec05562..d5711f699 100644 --- a/packages/api-client/tsconfig.json +++ b/packages/api-client/tsconfig.json @@ -68,6 +68,6 @@ "skipLibCheck": true, /* Skip type checking of declaration files. */ "forceConsistentCasingInFileNames": true , /* Disallow inconsistently-cased references to the same file. */ }, - "include": ["lib/"], + "include": ["lib/", "schema/"], "exclude": ["**/*.spec.ts"] } diff --git a/packages/dashboard/src/components/tasks/task-panel.tsx b/packages/dashboard/src/components/tasks/task-panel.tsx index 1ca4a7067..7b63b313f 100644 --- a/packages/dashboard/src/components/tasks/task-panel.tsx +++ b/packages/dashboard/src/components/tasks/task-panel.tsx @@ -19,7 +19,7 @@ import { Typography, useTheme, } from '@mui/material'; -import { DispatchTaskRequest, TaskEventLog, TaskState } from 'api-client'; +import { TaskEventLog, TaskRequest, TaskState } from 'api-client'; import React from 'react'; import { CreateTaskForm, CreateTaskFormProps, TaskInfo, TaskTable } from 'react-components'; import { UserProfileContext } from 'rmf-auth'; @@ -160,13 +160,13 @@ export function TaskPanel({ }, [cancelTask, selectedTask]); // /* istanbul ignore next */ - const tasksFromFile = (): Promise => { + const tasksFromFile = (): Promise => { return new Promise((res) => { const fileInputEl = uploadFileInputRef.current; if (!fileInputEl) { return []; } - let taskFiles: DispatchTaskRequest[]; + let taskFiles: TaskRequest[]; const listener = async () => { try { if (!fileInputEl.files || fileInputEl.files.length === 0) { diff --git a/packages/dashboard/src/components/tasks/utils.ts b/packages/dashboard/src/components/tasks/utils.ts index 6330434d2..f3332bac3 100644 --- a/packages/dashboard/src/components/tasks/utils.ts +++ b/packages/dashboard/src/components/tasks/utils.ts @@ -1,29 +1,17 @@ -import Ajv, { ValidateFunction } from 'ajv'; -import { DispatchTaskRequest } from 'api-client'; -import schema from 'api-client/openapi/schema'; - -let validate: ValidateFunction | null = null; - -function getValidator() { - if (validate) { - return validate; - } - const ajv = new Ajv(); - validate = ajv.compile(schema.components.schemas.DispatchTaskRequest); - return validate; -} +import { TaskRequest } from 'api-client'; +import schema from 'api-client/dist/schema'; +import { ajv } from '../utils'; /* istanbul ignore next */ -export function parseTasksFile(contents: string): DispatchTaskRequest[] { +export function parseTasksFile(contents: string): TaskRequest[] { const obj = JSON.parse(contents) as unknown[]; if (!Array.isArray(obj)) { throw new Error('Expected an array of tasks'); } - const validate = getValidator(); - const errIdx = obj.findIndex((req) => !validate(req)); + const errIdx = obj.findIndex((req) => !ajv.validate(schema.components.schemas.TaskRequest, req)); if (errIdx !== -1) { - const errors = validate.errors!; + const errors = ajv.errors!; throw new Error(`Validation error on item ${errIdx + 1}: ${errors[0].message}`); } return obj; diff --git a/packages/dashboard/src/components/utils.ts b/packages/dashboard/src/components/utils.ts index ac280c665..cdb1d6cb4 100644 --- a/packages/dashboard/src/components/utils.ts +++ b/packages/dashboard/src/components/utils.ts @@ -1,5 +1,13 @@ +import Ajv from 'ajv'; +import schema from 'api-client/schema'; import { AxiosError } from 'axios'; export function getApiErrorMessage(error: unknown): string { return (error as AxiosError).response?.data.detail || ''; } + +export const ajv = new Ajv(); + +Object.entries(schema.components.schemas).forEach(([k, v]) => { + ajv.addSchema(v, `#/components/schemas/${k}`); +}); From 60538f6fce213604530a0a80091cc299743f21e3 Mon Sep 17 00:00:00 2001 From: Teo Koon Peng Date: Mon, 21 Feb 2022 17:34:04 +0800 Subject: [PATCH 77/79] fix use of any type Signed-off-by: Teo Koon Peng --- packages/react-components/lib/tasks/create-task.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/react-components/lib/tasks/create-task.tsx b/packages/react-components/lib/tasks/create-task.tsx index de31b11d7..8fa8f23c0 100644 --- a/packages/react-components/lib/tasks/create-task.tsx +++ b/packages/react-components/lib/tasks/create-task.tsx @@ -568,7 +568,7 @@ export interface CreateTaskFormProps dispensers?: string[]; ingestors?: string[]; submitTasks?(tasks: TaskRequest[]): Promise; - tasksFromFile?(): Promise | any[]; + tasksFromFile?(): Promise | TaskRequest[]; onSuccess?(tasks: any[]): void; onFail?(error: Error, tasks: any[]): void; } From bcf14d698b039b46f6b686bf27c41d8a1e342a9d Mon Sep 17 00:00:00 2001 From: Charayaphan Nakorn Boon Han Date: Fri, 25 Feb 2022 00:21:37 +0800 Subject: [PATCH 78/79] fix example deployment Signed-off-by: Charayaphan Nakorn Boon Han --- example-deployment/README.md | 13 +++++-- example-deployment/build-builder.sh | 1 - example-deployment/deploy.sh | 2 +- .../docker/dashboard.Dockerfile | 2 - .../docker/dashboard.dockerfile | 39 ------------------- .../docker/reporting-server.Dockerfile | 1 - .../docker/reporting.Dockerfile | 2 - .../docker/rmf-server.Dockerfile | 7 ++-- .../docker/rmf-server.build.Dockerfile | 1 - .../k8s/base/rmf-server/rmf-server.yaml | 19 +++++++++ .../k8s/example-full/rmf_server_config.py | 2 +- example-deployment/kustomize-env.sh | 5 +++ 12 files changed, 39 insertions(+), 55 deletions(-) delete mode 100644 example-deployment/docker/dashboard.dockerfile diff --git a/example-deployment/README.md b/example-deployment/README.md index dcb17088d..bdc667b05 100644 --- a/example-deployment/README.md +++ b/example-deployment/README.md @@ -36,7 +36,7 @@ others: For this example we will be using [rmf_demos](https://github.com/open-rmf/rmf_demos) as a local "deployment" of RMF, check that you have a working installation with ```bash -ros2 launch rmf_demos_gz office.launch.xml +RMW_IMPLEMENTATION=rmw_fastrtps_cpp ros2 launch rmf_demos_gz office.launch.xml ``` ## kubernetes @@ -276,9 +276,10 @@ The jobs we will run in this example can be found at `k8s/example-full/cronjobs. ## Test the deployment If not done so already, launch the office demo +NOTE: Due to DDS challenging behavior with minikube over NAT, we will use `rmw_fastrtps_cpp` to bypass NAT traversal using sharede memory transport. ```bash -ros2 launch rmf_demos_gz office.launch.xml headless:=true +RMW_IMPLEMENTATION=rmw_fastrtps_cpp ros2 launch rmf_demos_gz office.launch.xml headless:=1 use_sim_time:=false server_uri:=ws://example.com:8001 ``` Go to https://example.com/dashboard, if everything works, you should see a log in screen, use user=example, password=example. @@ -292,7 +293,7 @@ It can be very useful to automate everything mentioned above and instantly deplo Before you run the script, first you have to obtain the source. Refer to the above instructions if you don't know how to do it. You should have a git repo for rmf-web and a colcon workspace for rmf, then just run ```bash -./deploy.sh --rmf-ws --rmf-web-ws +./deploy.sh ``` Note: If you followed the above instructions to obtain the source, your rmf workspace will be in `ws/rmf`, and your rmf-web workspace will be in `ws/rmf-web`. So you will run it with `./deploy.sh --rmf-ws ws/rmf --rmf-web-ws ws/rmf`. @@ -399,7 +400,11 @@ If you can connect to rmf, there is a chance that there is some discovery issues ## Some containers crashes at first startup -Some deployments like the rmf-server may crash on the first startup, this is often due to the database not being ready yet. This is normal and kubernetes will automatically restart the container. +Some deployments like the rmf-server may crash on the first startup, this is often due to the database not being ready yet. This is normal and kubernetes will automatically restart the container. Alternatively, you can forcefully terminate the rmf-server to force a restart: +``` +kubectl get pods +kubectl delete pods [rmf-server-xxxx] +``` One solution is to add an init container to probe for the readiness of the database, but this comes at a small cost which is not normally expected to happen in an actual deployment. It is also not fail proof as there is no guarantee that diff --git a/example-deployment/build-builder.sh b/example-deployment/build-builder.sh index c55128171..2f1a7c31d 100755 --- a/example-deployment/build-builder.sh +++ b/example-deployment/build-builder.sh @@ -13,7 +13,6 @@ cd $root_dir mkdir -p build/builder/ cd $1 -cp lerna.json "$root_dir/build/builder/" find . -name node_modules -prune -o -name build -prune -o \ \(\ -name 'package*.json' -o \ diff --git a/example-deployment/deploy.sh b/example-deployment/deploy.sh index 9c612aae0..2c0622ece 100755 --- a/example-deployment/deploy.sh +++ b/example-deployment/deploy.sh @@ -71,7 +71,7 @@ echo '🗒 setting up apps and users' try() { "$@" || (sleep 1 && "$@") || (sleep 5 && "$@") } -try node keycloak-tools/bootstrap-keycloak.js +try node keycloak-tools/bootstrap-keycloak.js || true # persistent keycloak database might fail this script if it has already been run before try node keycloak-tools/get-cert.js > k8s/example-full/keycloak/keycloak.pem openssl x509 -in k8s/example-full/keycloak/keycloak.pem -pubkey -noout -out k8s/example-full/keycloak/jwt-pub-key.pub echo '✅ successfully setup keycloak' diff --git a/example-deployment/docker/dashboard.Dockerfile b/example-deployment/docker/dashboard.Dockerfile index 59718f7d2..ee9f95cd0 100644 --- a/example-deployment/docker/dashboard.Dockerfile +++ b/example-deployment/docker/dashboard.Dockerfile @@ -2,8 +2,6 @@ ARG BUILDER_TAG FROM rmf-web/builder:$BUILDER_TAG COPY . /root/rmf-web -RUN cd /root/rmf-web && \ - lerna run prepare --include-dependencies --scope=rmf-dashboard ARG PUBLIC_URL ARG REACT_APP_TRAJECTORY_SERVER diff --git a/example-deployment/docker/dashboard.dockerfile b/example-deployment/docker/dashboard.dockerfile deleted file mode 100644 index 2272dca8f..000000000 --- a/example-deployment/docker/dashboard.dockerfile +++ /dev/null @@ -1,39 +0,0 @@ -FROM rmf-web/builder -COPY . /root/rmf-web -SHELL ["bash", "-c"] - -RUN . /opt/rmf/setup.bash && npm config set unsafe-perm && cd /root/rmf-web && \ - CI=1 npm install -g lerna@4 && lerna bootstrap --scope=rmf-dashboard - -RUN cd /root/rmf-web/packages/dashboard && \ - PUBLIC_URL='/dashboard' \ - REACT_APP_TRAJECTORY_SERVER='ws://localhost:8006' \ - REACT_APP_RMF_SERVER='https://example.com/rmf/api/v1' \ - REACT_APP_AUTH_PROVIDER='keycloak' \ - REACT_APP_KEYCLOAK_CONFIG='{ "realm": "rmf-web", "clientId": "dashboard", "url": "https://example.com/auth" }' \ - npm run build - -### - -FROM nginx:stable -COPY --from=0 /root/rmf-web/packages/dashboard/build /usr/share/nginx/html/dashboard -SHELL ["bash", "-c"] -RUN echo -e 'server {\n\ - listen 80;\n\ - server_name localhost;\n\ -\n\ - location / {\n\ - root /usr/share/nginx/html;\n\ - index index.html index.htm;\n\ - try_files $uri /dashboard/index.html;\n\ - }\n\ -\n\ - location /dashboard/static/ {\n\ - expires 30d;\n\ - }\n\ -\n\ - error_page 500 502 503 504 /50x.html;\n\ - location = /50x.html {\n\ - root /usr/share/nginx/html;\n\ - }\n\ -}\n' > /etc/nginx/conf.d/default.conf diff --git a/example-deployment/docker/reporting-server.Dockerfile b/example-deployment/docker/reporting-server.Dockerfile index 1608cc7db..37780dc0a 100644 --- a/example-deployment/docker/reporting-server.Dockerfile +++ b/example-deployment/docker/reporting-server.Dockerfile @@ -3,7 +3,6 @@ FROM rmf-web/builder:$BUILDER_TAG COPY . /root/rmf-web RUN cd /root/rmf-web && \ - lerna run prepare --include-dependencies --scope=reporting-server && \ cd packages/reporting-server && \ npm run prepack diff --git a/example-deployment/docker/reporting.Dockerfile b/example-deployment/docker/reporting.Dockerfile index a083b44c9..7f050b34e 100644 --- a/example-deployment/docker/reporting.Dockerfile +++ b/example-deployment/docker/reporting.Dockerfile @@ -2,8 +2,6 @@ ARG BUILDER_TAG FROM rmf-web/builder:$BUILDER_TAG COPY . /root/rmf-web -RUN cd /root/rmf-web && \ - lerna run prepare --include-dependencies --scope=reporting ARG PUBLIC_URL ARG REACT_APP_REPORTING_SERVER diff --git a/example-deployment/docker/rmf-server.Dockerfile b/example-deployment/docker/rmf-server.Dockerfile index c2ecd781f..c54a231a8 100644 --- a/example-deployment/docker/rmf-server.Dockerfile +++ b/example-deployment/docker/rmf-server.Dockerfile @@ -1,6 +1,6 @@ FROM rmf-web/rmf-server:build as stage0 -FROM ros:foxy-ros-base-focal +FROM ros:galactic SHELL ["bash", "-c"] @@ -15,7 +15,8 @@ COPY rmf/rmf_internal_msgs/rmf_traffic_msgs /root/rmf_ws/src/rmf_traffic_msgs COPY rmf/rmf_internal_msgs/rmf_workcell_msgs /root/rmf_ws/src/rmf_workcell_msgs COPY rmf/rmf_building_map_msgs /root/rmf_ws/src/rmf_building_map_msgs -RUN . /opt/ros/foxy/setup.bash && cd /root/rmf_ws && \ +RUN apt update && apt install -y ros-galactic-rmw-fastrtps-cpp +RUN . /opt/ros/galactic/setup.bash && cd /root/rmf_ws && \ colcon build --merge-install --install-base /opt/rmf --cmake-args -DCMAKE_BUILD_TYPE=Release && \ rm -rf /root/rmf_ws @@ -27,6 +28,6 @@ RUN cd /root/rmf-server && \ RUN echo -e '#!/bin/bash\n\ . /opt/rmf/setup.bash\n\ - exec rmf_api_server "$@"\n\ + rmf_api_server "$@"\n\ ' > /docker-entry-point.sh && chmod +x /docker-entry-point.sh ENTRYPOINT ["/docker-entry-point.sh"] diff --git a/example-deployment/docker/rmf-server.build.Dockerfile b/example-deployment/docker/rmf-server.build.Dockerfile index 04c5f6f4f..2ea193a4f 100644 --- a/example-deployment/docker/rmf-server.build.Dockerfile +++ b/example-deployment/docker/rmf-server.build.Dockerfile @@ -3,6 +3,5 @@ FROM rmf-web/builder:$BUILDER_TAG COPY . /root/rmf-web RUN cd /root/rmf-web && \ - lerna run prepare --include-dependencies --scope=api-server && \ cd packages/api-server && \ npm run prepack diff --git a/example-deployment/k8s/base/rmf-server/rmf-server.yaml b/example-deployment/k8s/base/rmf-server/rmf-server.yaml index d7bac4d33..54995195c 100644 --- a/example-deployment/k8s/base/rmf-server/rmf-server.yaml +++ b/example-deployment/k8s/base/rmf-server/rmf-server.yaml @@ -80,6 +80,23 @@ spec: ports: - protocol: TCP port: 8000 + +--- +apiVersion: v1 +kind: Service +metadata: + name: rmf-server-ws + labels: + app: rmf-server-ws + tier: app +spec: + selector: + app: rmf-server + tier: app + ports: + - protocol: TCP + port: 8001 + --- apiVersion: apps/v1 kind: Deployment @@ -107,6 +124,8 @@ spec: env: - name: RMF_API_SERVER_CONFIG value: /rmf-server-config/rmf_server_config.py + - name: RMW_IMPLEMENTATION + value: rmw_fastrtps_cpp volumeMounts: - mountPath: /rmf-server-config name: rmf-server-config diff --git a/example-deployment/k8s/example-full/rmf_server_config.py b/example-deployment/k8s/example-full/rmf_server_config.py index 367745d24..df2c0874b 100644 --- a/example-deployment/k8s/example-full/rmf_server_config.py +++ b/example-deployment/k8s/example-full/rmf_server_config.py @@ -4,7 +4,7 @@ config = deepcopy(default_config) config["host"] = "0.0.0.0" -config["port"] = 8000 +config["base_port"] = 8000 config["db_url"] = "postgres://rmf-server:rmf-server@rmf-server-db/rmf-server" config["public_url"] = "https://example.com/rmf/api/v1" config["log_level"] = "INFO" diff --git a/example-deployment/kustomize-env.sh b/example-deployment/kustomize-env.sh index 691945f66..eaa8c2d2a 100755 --- a/example-deployment/kustomize-env.sh +++ b/example-deployment/kustomize-env.sh @@ -1,4 +1,9 @@ #!/bin/bash set -e +kubectl() { + .bin/minikube kubectl -- "$@" +} +export -f kubectl + kubectl kustomize "$1" | envsubst From c173b1d31089d3be7e796b3c3aa2f0e898d8a81f Mon Sep 17 00:00:00 2001 From: Charayaphan Nakorn Boon Han Date: Fri, 25 Feb 2022 00:47:58 +0800 Subject: [PATCH 79/79] fix routing for reporting server Signed-off-by: Charayaphan Nakorn Boon Han --- example-deployment/docker/reporting.Dockerfile | 4 ---- 1 file changed, 4 deletions(-) diff --git a/example-deployment/docker/reporting.Dockerfile b/example-deployment/docker/reporting.Dockerfile index 7f050b34e..c4d53aff4 100644 --- a/example-deployment/docker/reporting.Dockerfile +++ b/example-deployment/docker/reporting.Dockerfile @@ -29,10 +29,6 @@ RUN echo -e 'server {\n\ index index.html index.htm;\n\ try_files $uri /reporting/index.html;\n\ }\n\ -\n\ - location /reporting/static/ {\n\ - expires 30d;\n\ - }\n\ \n\ error_page 500 502 503 504 /50x.html;\n\ location = /50x.html {\n\