New revision of dialog available in response header after change

[elsand]

Introduction

Whenever a part of the dialog aggregate is changed, causing a new revision to made, the new revision should be made available to callers

Description

In order for a client to keep track of revisions, whenever a POST is performed for a new dialog, a PUT/PATCH is performed on an existing dialog, or a POST is performed to add a transmission or activity, the updated revision id should be made available in a HTTP response header.

Implementation

As this is a custom reponse header, it should be prefixed with x-, such as x-dialog-new-revision-id
Using ETag standard: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag

Tasks

Preview Give feedback

1. Add response header to all commands causing a dialog revision to be updated
2. Prepare documentation (if relevant - either update working document, or add a new file in docs)
3. Add e2e-test (if relevant)

Threat modelling

Preview Give feedback

1. Does this change introduce any potential security issues? No

Acceptance criteria

Case 1: New Dialog Created

GIVEN a client performs a POST request to create a new dialog,
WHEN the dialog is successfully created,
THEN the response includes an Etag header containing the new revision ID.

Case 2: Existing Dialog Updated

GIVEN a client performs a PUT or PATCH request to update an existing dialog,
WHEN the update is successful and a new revision is created,
THEN the response includes an Etag header containing the updated revision ID.

Case 3: Transmission or Activity Added

GIVEN a client performs a POST request to add a transmission or activity to a dialog,
WHEN the addition is successful and a new revision is created,
THEN the response includes an Etag header containing the new revision ID.

Negative Case: No Revision Created

GIVEN a client performs any of the above requests,
WHEN the operation fails or does not result in a new revision being created,
THEN the response does not include the Etag header.

[LeifHelstad]

Test

Regner med at svaret vi ser etter ligger i "Headers" tilhørende "Response" som bærer nyopprettet dialog-id:

Men alle response headers som er prefixet med "x-" er disse:

Kan den være pakket inn i andre deler av response header?

[oskogstad]

@LeifHelstad Ser du en Etag-header?
Oppdatert tekst på issuet

[LeifHelstad]

Test

(Lette etter ETag på feil sted i første testforsøk. Sjekket response headers i nettleser og ikke i postman web klient. Leter rett nå.)

Case 1:

Ny dialog: "01945f94-1716-707b-ae38-fdd0d2671d17"
ETag: 2df07041-39e6-49c3-abad-132593288164

Case 3:

Legger til en Transmission på dialog "01945f94-1716-707b-ae38-fdd0d2671d17"
Ny transmission: "01945fdf-48ec-7049-b7e9-0493e4237d1b"
ETag: bf68e069-ce20-4fb7-90b5-da02b0fc06f2

Negative Case:

Skader dialogid fra ved å bytte siste 17 med 28 "01945f94-1716-707b-ae38-fdd0d2671d28"
"errors": {
"DialogEntity": [
"Entity 'DialogEntity' with the following key(s) was not found: (01945f94-1716-707b-ae38-fdd0d2671d28)."
]
}
Det blir ikke dannet noen ETag header. Antallet Headers har gått ned fra 5 i vellykkede forsøk til 4 nå.