[Story] Safe Mode

[Gnuxie]

Description

A Draupnir moderator's Mjolnir fails to start due to a configuration issue. For example, sometimes it's not possible for the homeserver to find the room associated with a room reference in org.matrix.mjonir.watched_lists and we have previously had to encourage them to manually login as the Mjolnir user, open devtools, and remove the reference from the event manually. This is obviously not something that is at all possible in draupnir4all or for a non technical user. Instead, Draupnir starts in a limited safe mode, and no protections are given any capabilities for consequences. The moderator is well aware that Draupnir is in safe mode and is notified about the source of the problem (e.g. watched lists config) even if an exact diagnosis cannot be given. The user should be able to use commands to edit the configuration in account data or room state without opening up devtools. After the configuration has been edited, the user should be able to restart the bot into the normal mode of operation by issuing a command.

Acceptance Criteria

• It is obvious to the moderator that Draupnir is in safe mode, even if days have passed since the failure happened and there is lots of scrollback to reach that point
• It is obvious which part of the config needs attention and what steps to take to remedy it (e.g. using rooms remove or rooms add). Even if the exact reason for the config's failure to load is not diagnosable.
• It is possible to introspect on the config. That isn't to say the exact JSON needs to be presented, that could be too technical.
• It is ovbious how to attempt to restart Draupnir normally in any notification relating to Draupnir being in safe mode

Issues

• https://github.com/the-draupnir-project/Draupnir/issues/149
• https://github.com/the-draupnir-project/Draupnir/issues/338
• https://github.com/the-draupnir-project/Draupnir/issues/218
• https://github.com/the-draupnir-project/Draupnir/issues/413

Tasks

• https://github.com/the-draupnir-project/planning/issues/26
• https://github.com/the-draupnir-project/planning/issues/29
• https://github.com/the-draupnir-project/planning/issues/30

Dependencies

Total Pain

54

[Gnuxie]

This needs breaking up some more. We need to describe precisely how we will unify config in one model that requires a description object that describes with a JSON path where the value came from (as in the specific file, or MPS interface implementation, or a default).

After this is done, the implication is that the old config/production.yaml will be parsed using JSONSchema before we pick off and feed the unified config model.

[Gnuxie]

It should be noted that until we have #6 we will just have to disable all protections outright in safe mode.

[Gnuxie]

Feedback:

• Update recover command to ask for confirmation https://github.com/the-draupnir-project/Draupnir/issues/602
• Add a command to show the filesystem based configuration - I don't see this as particularly useful now that the logging is simple and covers the corners