Implement support for hiding a dialog

[elsand]

Introduction

We need to support user-driven actions to hide dialogs from the inbox (or any view)

Description

There are three distinct and mutually exclusive display states; "default", "bin" and "archive", that should have global effect, and should be fully user manageble for users with write access to the dialog. These states should also be possible for service owners to be set upon dialog creation, to support migration scenarios.

Implementation

The implementation should take into account the label concept described in #198, as this also controls the current display state. In particular, there should be a shared log for changing display state and eventually label (un)assignments.

We want to introduce a new aggregate, DialogEndUserContext, that lays the groundwork for these display states - implemented as "system labels" - and eventually user defined labels.

There should be a separate entity, eg. called "SystemLabel", which is a type table which all DialogEndUserContexts refers to. There should be three system labels; Default, Bin, Archive.

The log entity should be "LabelAssignmentLog" and should contain information about

• the related system label (or, eventually, user label)
• timestamp
• actor
• action (set, remove)

The follow endpoints should be added:

GET /enduser/dialogs/{dialogId}/labellog

Should return a list of log entries:

[
  {
      "name": "systemlabel:bin",
      "action": "set",
      "performedAt" : "<iso timestamp>",
      "performedBy": { <actor> }
  },
  {
      "name": "systemlabel:bin",
      "action": "remove",
      "performedAt" : "<iso timestamp>",
      "performedBy": { <actor> }
  }
]

In order to change the display-state, the following EU endpoints should be made available

POST /enduser/dialogs/{dialogId}/labels

which should contain a body containing the requested system label, ie:

{
    "label": "systemlabel:bin"
}

• The user should have "write" access to the service resource referred to by the dialog for the dialog party, failing that should return 403 Forbidden
• If authorized, requests should return a 204 No Content.
  • If the previous system labels was "default", and new system labels is either "bin" or "archive", a single "set" entry should be added with name set to the new state, ie either "systemlabel:bin" or "systemlabel:archive"
  • If the previous system labels was "bin" or "archive", and the new system labels is "default", a single "remove" entry should be added with the name set to the previous state, ie either "systemlabel:bin" or "systemlabel:archive"
  • If the previous system labels was "bin" and the new system labels is "archive", two log entries should be added with a action "remove" for name "systemlabel:bin" and action "set" for "systemlabel:archive"
  • If the previous system labels was "archive" and the new system labels is "bin", two log entries should be added with a action "remove" for name "systemlabel:archive" and action "set" for "systemlabel:bin"
  • If the new state matches the previous state, no log entries should be added
• The endpoint should support optimistic concurrency checks with with If-Match, same as UpdateDialogCommand

Extension of Dialog DTOs

The dialog DTOs (for both search and details endpoints for both EU and SO) should be expanded to contain the enum for the current system labels

"systemLabel": "Default"

The search endpoint should be extended to take a parameter for systemLabel, ie "SystemLabel=bin" should return a list of dialogs with the supplied system labels.

Extension of CreateDialogCommand

Service providers should be allowed to set "systemLabel" in CreateDialogCommand. The label assignment log should reflect this and have the actor set to the service owner organization number

Automatic set of "Default" upon change

The dialog should have its system label automatically set to "Default" whenever the service owner updates the dialog. The assignment log should reflect this.

Tasks

Preview Give feedback

1. Add tables / db migration
2. Add new enduser endpoints and validations/authorizations
3. Update query DTOs for both SO and EU
4. Add search parameter
5. Update DialogCreateCommand to handle setting of systemLabel
6. Update DialogUpdateCommand to set systemLabel to Default
7. Prepare documentation (separate PR)
8. Add e2e-test

Threat modelling

Preview Give feedback

1. This adds enduser write endpoints which must be properly secured
2. Consider mitigations of users stuffing logs (spamming POSTs to change system labels)

Acceptance criteria

TBW