Hammer/generic alerts #948

aaronchongth · 2024-05-28T07:53:42Z

What's new

This works with open-rmf/rmf_internal_msgs#71

Replaces the existing task alert system to be much more flexible and generic, with the key purpose to support the smart cart API server interaction.

Test with regular task

task complete
failed dispatch

Test with fleet alerts

ros2 topic pub /fleet_alert rmf_fleet_msgs/msg/FleetAlert '{id: test2, title: title, subtitle: subtitle, message: message, display: true, tier: 0, responses_available: [move_off, timeout], alert_parameters: [{name: waiting_at, value: test_location}], task_id: test_task}' --once

What's next:

Migrate delivery_alerts to use this as well
Frontend for new task types

Self-checks

I have prototyped this new feature (if necessary) on Figma
I'm familiar with and follow this Typescript guideline
I added unit-tests for new components
I tried testing edge cases
I tested the behavior of the components that interact with the backend, with an e2e test

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

codecov · 2024-05-28T08:02:18Z

Codecov Report

Attention: Patch coverage is 1.32450% with 149 lines in your changes missing coverage. Please review.

Please upload report for BASE (deploy/hammer-humble@3649b5e). Learn more about missing BASE report.

Files	Patch %	Lines
...ackages/dashboard/src/components/alert-manager.tsx	0.00%	134 Missing ⚠️
packages/dashboard/src/components/appbar.tsx	20.00%	8 Missing ⚠️
...shboard/src/components/tasks/task-cancellation.tsx	0.00%	7 Missing ⚠️

Additional details and impacted files

@@                   Coverage Diff                   @@
##             deploy/hammer-humble     #948   +/-   ##
=======================================================
  Coverage                        ?   13.55%           
=======================================================
  Files                           ?       66           
  Lines                           ?     3099           
  Branches                        ?      911           
=======================================================
  Hits                            ?      420           
  Misses                          ?     2673           
  Partials                        ?        6

Flag	Coverage Δ
dashboard	`13.55% <1.32%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

…cation alerts checking Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

koonpeng

Haven't look through the whole thing yet.

packages/api-server/api_server/routes/alerts.py

packages/api-server/api_server/repositories/alerts.py

packages/api-server/api_server/gateway.py

* First round of cleanup Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Regenerate API Signed-off-by: Aaron Chong <aaronchongth@gmail.com> --------- Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

* Moved custom deliveries to separate file naively and import naively Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Moved patrol Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Moved custom-compose Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Added clean and delivery Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Added delivery, renamed to SimpleDelivery Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Clean task added Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Moved delivery-custom tests, added return type for forms Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Configurable supported tasks and name remapping Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Changed directory to types, since it doesn't just handle descriptions Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Fix test imports Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Using temporary task definition Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Refactoring new rename changes Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Clean up Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Removed problematic and unsused component and test Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Lint Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Updating pnpm version in github workflow Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Reverting update to pnpm version Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Fix build now that we use key value strings for labels Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Refactored last parts of hard coding categories and rendering forms Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Refactor callback names and error handling for misconfigs Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Display error as well Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Fixed more checks and failures Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Split configuration and definition, only handle configurations in resource manager level Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Lint Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Not using object as a type Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Address feedback Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Render using validTasks instead Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Use useMemo Signed-off-by: Aaron Chong <aaronchongth@gmail.com> --------- Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

…ble" This reverts commit 1fd22ee. Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

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

packages/api-server/api_server/gateway.py

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

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

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

packages/dashboard/src/components/appbar.tsx

packages/dashboard/src/components/alert-store.tsx

packages/dashboard/src/components/appbar.tsx

koonpeng · 2024-07-04T09:26:39Z

not sure if this image is still updated, there are multiple issues with the design

The number of available responses is unbounded, better to list them in a dropdown.
The buttons are different size.

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

koonpeng · 2024-07-05T03:09:25Z

A suggestion for the alert responses is to use split buttons https://mui.com/material-ui/react-button-group/#split-button

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

…ion for unackw query, updated API Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

packages/api-server/api_server/repositories/alerts.py

packages/dashboard/src/components/alert-manager.tsx

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

* First iteration of generic alerts Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Route for unresponded alerts Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Basic location complete post route for task Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Tests for alert routes Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Test for location complete route Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Lint and tests Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Basic implementation Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Basic task based alerts working as expected Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Only display and list alerts that have display true Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Add doc to location_complete route about instability Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Refactored alert db interactions to repository, with lru cache for location alerts checking Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Regenerated docs and return early on gateway last location checking Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Lint and better typing with static methods Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Hammer/generic alerts without location (#951) * First round of cleanup Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Regenerate API Signed-off-by: Aaron Chong <aaronchongth@gmail.com> --------- Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Hammer/demo tasks (#925) * Moved custom deliveries to separate file naively and import naively Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Moved patrol Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Moved custom-compose Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Added clean and delivery Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Added delivery, renamed to SimpleDelivery Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Clean task added Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Moved delivery-custom tests, added return type for forms Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Configurable supported tasks and name remapping Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Changed directory to types, since it doesn't just handle descriptions Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Fix test imports Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Using temporary task definition Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Refactoring new rename changes Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Clean up Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Removed problematic and unsused component and test Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Lint Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Updating pnpm version in github workflow Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Reverting update to pnpm version Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Fix build now that we use key value strings for labels Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Refactored last parts of hard coding categories and rendering forms Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Refactor callback names and error handling for misconfigs Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Display error as well Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Fixed more checks and failures Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Split configuration and definition, only handle configurations in resource manager level Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Lint Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Not using object as a type Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Address feedback Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Render using validTasks instead Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Use useMemo Signed-off-by: Aaron Chong <aaronchongth@gmail.com> --------- Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Update ros2 pydantic messages, fix tests Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Revert update of pnpm lock file Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Lint Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Use specific exceptions and more clean up Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Port CI fixes from #955 but targeting ubuntu 22 and ROS 2 Humble Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Revert "Port CI fixes from #955 but targeting ubuntu 22 and ROS 2 Humble" This reverts commit 1fd22ee. Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Update pnpm version Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Setup pnpm and node manually Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Using HOME env var of runner Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * workflow Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * workflow Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Workflow Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Address feedback on frontend Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Address comments that don't break behavior Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Started generic exceptions Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Proper db schema for alert request and response Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Updated alerts model, frontend tweaks for subscription, using pagination for unackw query, updated API Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Attempt to setup minimal RMF during bootstrap step Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Fix mistake on ci path Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Fix workflow Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Revert CI changes Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Updated API, renamed event to pushAlert, filter before Signed-off-by: Aaron Chong <aaronchongth@gmail.com> --------- Signed-off-by: Aaron Chong <aaronchongth@gmail.com> (cherry picked from commit 090dd9b) Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

aaronchongth added 9 commits May 23, 2024 13:34

First iteration of generic alerts

4d75109

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Route for unresponded alerts

d2a7d58

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Merge branch 'deploy/hammer' into hammer/generic-alerts

907f739

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Basic location complete post route for task

a18d89b

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Tests for alert routes

3e4a4ef

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Test for location complete route

93467ca

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Lint and tests

c4a76d8

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Basic implementation

f48bc5c

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Basic task based alerts working as expected

6e2d54e

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

aaronchongth added 5 commits May 28, 2024 17:12

Only display and list alerts that have display true

e45452d

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Add doc to location_complete route about instability

deca732

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Refactored alert db interactions to repository, with lru cache for lo…

b7c04a5

…cation alerts checking Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Regenerated docs and return early on gateway last location checking

99855f8

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Lint and better typing with static methods

78f5e0b

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

koonpeng requested changes May 30, 2024

View reviewed changes

aaronchongth added 7 commits June 20, 2024 15:27

Hammer/generic alerts without location (#951)

cb1b563

* First round of cleanup Signed-off-by: Aaron Chong <aaronchongth@gmail.com> * Regenerate API Signed-off-by: Aaron Chong <aaronchongth@gmail.com> --------- Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Merge branch 'deploy/hammer' into hammer/generic-alerts

4e93451

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Update ros2 pydantic messages, fix tests

37201c9

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Revert update of pnpm lock file

95ffb2c

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Lint

b413658

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Use specific exceptions and more clean up

c5dc60b

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

aaronchongth requested a review from koonpeng July 1, 2024 07:43

aaronchongth changed the base branch from deploy/hammer to deploy/hammer-humble July 3, 2024 09:08

aaronchongth added 3 commits July 4, 2024 10:30

Merge branch 'deploy/hammer-humble' into hammer/generic-alerts

5237e72

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Port CI fixes from #955 but targeting ubuntu 22 and ROS 2 Humble

1fd22ee

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Revert "Port CI fixes from #955 but targeting ubuntu 22 and ROS 2 Hum…

01d68fe

…ble" This reverts commit 1fd22ee. Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

aaronchongth force-pushed the hammer/generic-alerts branch from 2e9cb5c to 01d68fe Compare July 4, 2024 02:54

Update pnpm version

2b4c763

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

aaronchongth added 5 commits July 4, 2024 13:52

Setup pnpm and node manually

1771015

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Using HOME env var of runner

d51ef77

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

workflow

0e8d7c4

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

workflow

18a075d

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Workflow

2b58f8e

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

koonpeng requested changes Jul 4, 2024

View reviewed changes

Address feedback on frontend

2bfd484

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

aaronchongth added 4 commits July 5, 2024 11:09

Address comments that don't break behavior

9434771

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Started generic exceptions

cc9a268

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Proper db schema for alert request and response

06e5475

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Updated alerts model, frontend tweaks for subscription, using paginat…

ce5d761

…ion for unackw query, updated API Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

aaronchongth force-pushed the hammer/generic-alerts branch from fa1ba7e to ce5d761 Compare July 5, 2024 05:06

aaronchongth added 5 commits July 5, 2024 13:21

Attempt to setup minimal RMF during bootstrap step

a152639

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Fix mistake on ci path

822a6b5

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Fix workflow

7e94210

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Revert CI changes

2738146

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

Merge branch 'deploy/hammer-humble' into hammer/generic-alerts

ebca221

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

aaronchongth requested a review from koonpeng July 5, 2024 05:55

Merge branch 'deploy/hammer-humble' into hammer/generic-alerts

2e78fde

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

koonpeng approved these changes Jul 5, 2024

View reviewed changes

packages/api-server/api_server/repositories/alerts.py Outdated Show resolved Hide resolved

packages/dashboard/src/components/alert-manager.tsx Outdated Show resolved Hide resolved

Updated API, renamed event to pushAlert, filter before

6494c01

Signed-off-by: Aaron Chong <aaronchongth@gmail.com>

aaronchongth merged commit 090dd9b into deploy/hammer-humble Jul 9, 2024
4 checks passed

aaronchongth deleted the hammer/generic-alerts branch July 9, 2024 16:30

aaronchongth mentioned this pull request Jul 23, 2024

Towards rmf-web's first tagged release #974

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Hammer/generic alerts #948

Hammer/generic alerts #948

aaronchongth commented May 28, 2024 •

edited

Loading

codecov bot commented May 28, 2024 •

edited

Loading

koonpeng left a comment

koonpeng commented Jul 4, 2024

koonpeng commented Jul 5, 2024

Hammer/generic alerts #948

Hammer/generic alerts #948

Conversation

aaronchongth commented May 28, 2024 • edited Loading

What's new

Test with regular task

Test with fleet alerts

What's next:

Self-checks

codecov bot commented May 28, 2024 • edited Loading

Codecov Report

koonpeng left a comment

Choose a reason for hiding this comment

koonpeng commented Jul 4, 2024

koonpeng commented Jul 5, 2024

aaronchongth commented May 28, 2024 •

edited

Loading

codecov bot commented May 28, 2024 •

edited

Loading