Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(notify-server): Delete notify-server #14280

Merged
merged 10 commits into from
Jan 30, 2024
Merged

Conversation

SyntaxColoring
Copy link
Contributor

@SyntaxColoring SyntaxColoring commented Jan 3, 2024

Overview

This deletes the notify-server project.

Years ago, we added notify-server because we thought it would be helpful for getting the robot to provide realtime notifications to clients. However, shifting priorities meant that it never developed beyond a proof-of-concept. It let you listen for door-opened/door-closed events, but that's it.

Realtime notifications are getting renewed interest, but we no longer think notify-server is the way to do them.

Deleting the project saves some CI time and relieves us from maintaining its dependencies.

This PR has an OT-2 Buildroot co-dependency: Opentrons/buildroot#215

Test Plan

Grab images from the build server (ot2-system.zip/system-update.zip) and push them to an OT-2 and Flex. Make sure robot-server still starts, and journalctl doesn't show any systemd errors complaining about a missing unit or anything like that.

Changelog

The user-facing changes entailed by deleting this project are:

  • Remove the /notifications/subscribe WebSocket endpoint. As far as I can tell, it was not publicly documented.
  • Remove the notify_server package and script from the robot. These were described in notify-server/README.rst, but otherwise not advertised, as far as I can tell.

There is currently no replacement for these removals, although we are planning one. Meanwhile, I recommend simply polling GET /robot/door/status.

Review requests

If anyone has reason to believe that anyone cares about these features, speak now or forever fold your pizza.

Risk assessment

Very low, assuming no one cares about these features.

@SyntaxColoring SyntaxColoring added the DO NOT MERGE Indicates a PR should not be merged, even if there's a shiny green merge button available label Jan 3, 2024
Copy link

codecov bot commented Jan 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fd7ddee) 68.24% compared to head (61cd751) 68.23%.
Report is 1 commits behind head on edge.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             edge   #14280      +/-   ##
==========================================
- Coverage   68.24%   68.23%   -0.02%     
==========================================
  Files        2512     2512              
  Lines       71877    71868       -9     
  Branches     9175     9175              
==========================================
- Hits        49055    49041      -14     
- Misses      20656    20661       +5     
  Partials     2166     2166              
Flag Coverage Δ
app 64.83% <ø> (ø)
components 49.62% <ø> (ø)
g-code-testing 96.48% <ø> (ø)
hardware 57.23% <ø> (-0.06%) ⬇️
hardware-testing ∅ <ø> (∅)
shared-data 75.25% <ø> (ø)
system-server 96.04% <ø> (ø)
update-server 63.58% <ø> (ø)
usb-bridge 76.94% <ø> (ø)

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

Files Coverage Δ
robot-server/robot_server/hardware.py 78.33% <ø> (-2.83%) ⬇️
robot-server/robot_server/router.py 100.00% <ø> (ø)

... and 2 files with indirect coverage changes

@SyntaxColoring SyntaxColoring added ot3-build Do an OT-3 system build for this branch. ot2-build Do an ot-2 build for this branch labels Jan 3, 2024
@SyntaxColoring SyntaxColoring changed the title feat(notify-server): Delete notify server feat(notify-server): Delete notify-server Jan 3, 2024
@SyntaxColoring SyntaxColoring changed the base branch from update-openembedded to edge January 4, 2024 17:58
@SyntaxColoring SyntaxColoring marked this pull request as ready for review January 4, 2024 18:01
@SyntaxColoring SyntaxColoring requested review from a team as code owners January 4, 2024 18:01
Copy link
Member

@sanni-t sanni-t left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good and shouldn't affect robot operations but still we should check on robots (esp the systemd notifications part). I can do an OT2 test if you haven't already.

robot-server/Pipfile.lock Outdated Show resolved Hide resolved
@SyntaxColoring
Copy link
Contributor Author

I’m seeing robot server startup failures. I think they’re related to the general dependency upgrades, outside of this PR, but we should hold off on merging until that’s confirmed.

@SyntaxColoring SyntaxColoring removed the DO NOT MERGE Indicates a PR should not be merged, even if there's a shiny green merge button available label Jan 30, 2024
@SyntaxColoring SyntaxColoring merged commit 7d691f0 into edge Jan 30, 2024
51 of 52 checks passed
@SyntaxColoring SyntaxColoring deleted the delete_notify_server branch January 30, 2024 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ot2-build Do an ot-2 build for this branch ot3-build Do an OT-3 system build for this branch.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants