Add support for device actions

[Steve-Mcl]

Ready to review, but please do not merge until both this and https://github.com/FlowFuse/flowfuse/pull/3548 are approved (in case of change requests from either side)

Description

Outline

Adds support for suspend, start and restart MQTT command actions (via the platform device comms)

Demo of FF side

Sample output from device agent when the actions are executed:

Details

• Adds new command route to mqtt.js: "action"
  • Supports "start", "suspend", "restart"
• Adds targetState property (persisted to the project file to ensure reboots to correct target state)
  • targetState supports only "running" and "suspended" at this time
• Converted hardcoded "state" strings into a an enum (was getting lost with all the supported states) $ added helper functions for verifying state
• To support timely and more accurate state feedback to FF, checkin is now called when state changes inside the launcher (important now we have transitional state info reporting on FF and necessary for good UX on the Actions menu items availability)
• Attempts to mitigate issue when agent is busy installing modules and the launcher is stopped by awaiting the install process for a few seconds grace before forcefully stopping. This was done as I managed cause a lock ups by ill timed restarts and suspends during testing.
  • NOTE: This was a balance struck on making the device "do what it is told" vs "leaving it "stuck installing" or "stuck starting" etc.
  • We may want to revisit and simply inhibit actions altogether while installation is occurring.

Tests added

  Agent
    actions
      ✔ suspends Node-RED
      ✔ reloads target state as suspended
      ✔ reloads target state as running
      ✔ restarts Node-RED
      ✔ starts Node-RED after suspend
    getState
      ✔ returns state when suspended

  MQTT Comms
    ✔ suspend action calls agent.suspendNR and checks in (573ms)
    ✔ start action calls agent.startNR and checks in (567ms)
    ✔ restart action calls agent.restartNR and checks in (576ms)
    ✔ Invalid action responds with error (568ms)

  State validation
    ✔ isValidState should return true for valid states
    ✔ isValidState should return false for invalid states
    ✔ isTargetState should return true for valid target states
    ✔ isTargetState should return false for invalid target states
    ✔ isTransitionState should return true for valid transition states
    ✔ isTransitionState should return false for invalid transition states

Related Issue(s)

https://github.com/FlowFuse/flowfuse/issues/3292

Checklist

• [x] I have read the contribution guidelines
• [x] Suitable unit/system level tests have been added and they pass
• [ ] Documentation has been updated
  • [ ] Upgrade instructions
  • [ ] Configuration details
  • [ ] Concepts
• [ ] Changes flowforge.yml?
  • [ ] Issue/PR raised on FlowFuse/helm to update ConfigMap Template
  • [ ] Issue/PR raised on FlowFuse/CloudProject to update values for Staging/Production

Labels

• [ ] Backport needed? -> add the backport label
• [ ] Includes a DB migration? -> add the area:migration label

[hardillb]

Not merging as pair PR not merged into forge app

[knolleary]

No structural changes being made in the forge app around how it will send commands to the device agent. We are only shipping the restart command initially as there are unresolved questions on the semantics of suspend (and thus start is also unnecessary).

@Steve-Mcl I think we're okay to merge this as-is?

[Steve-Mcl]

No structural changes being made in the forge app around how it will send commands to the device agent. We are only shipping the restart command initially as there are unresolved questions on the semantics of suspend (and thus start is also unnecessary).

@Steve-Mcl I think we're okay to merge this as-is?

Yeah. Ben and I have tested against local and staging.