Support annotation metadata in annotation PATCH-ing

[marcospri]

Testing

• Double check that editing an annotation still works as expected without any metadata

Create (if necessary) and edit an annotation in
https://hypothesis.instructure.com/courses/125/assignments/873

• Note the annotation id an get the UUID version of it

The URL version is on the URL of the PATCH call to http://localhost:5000/api/annotations/ANNO_ID

• Convert the ID to one usable in postgres

In [1]: from h.db.types import URLSafeUUID

In [2]: import uuid

In [3]: print(uuid.UUID(URLSafeUUID.url_safe_to_hex("_a6x_lI4Ee6Eai9rFQaNEg")))
fdaeb1fe-5238-11ee-846a-2f6b15068d12

• Check the annotation in the DB

docker compose exec postgres psql -U postgres -c "select annotation.id, annotation.pk, annotation.user_id, text, data from annotation left outer join annotation_metadata on annotation_pk = annotation.pk where annotation.id::text = 'fdaeb1fe-5238-11ee-846a-2f6b15068d12';"
                  id                  | pk | user_id |         text         | data 
--------------------------------------+----+---------+----------------------+------
 fdaeb1fe-5238-11ee-846a-2f6b15068d12 |    |         | Test anno edited - 1 | 
(1 row)

• Copy the curl request from the LMS client call to H, the PATCH to http://localhost:5000/api/annotations/ANNO_ID

edit the --data-raw parameter to include metadata_jwe with the JWE generated above, eg:

"metadata": {"assignment_id": 1}

• Check the anno in the DB

docker compose exec postgres psql -U postgres -c "select annotation.id, annotation.pk, annotation.user_id, text, data from annotation left outer join annotation_metadata on annotation_pk = annotation.pk where annotation.id::text = 'fdaeb1fe-5238-11ee-846a-2f6b15068d12';"
                  id                  |  pk  | user_id |         text         |             data              
--------------------------------------+------+---------+----------------------+-------------------------------
 fdaeb1fe-5238-11ee-846a-2f6b15068d12 | 3053 |       7 | Test anno edited - 3 | {"lms": {"assignment_id": 1}}
(1 row)

Now the annotation has metadata and the PK and user_id values.

• Curl again with other metadata and check the DB again:

docker compose exec postgres psql -U postgres -c "select annotation.id, annotation.pk, annotation.user_id, text, data from annotation left outer join annotation_metadata on annotation_pk = annotation.pk where annotation.id::text = 'fdaeb1fe-5238-11ee-846a-2f6b15068d12';"
                  id                  |  pk  | user_id |         text         |              data              
--------------------------------------+------+---------+----------------------+--------------------------------
 fdaeb1fe-5238-11ee-846a-2f6b15068d12 | 3053 |       7 | Test anno edited - 3 | {"lms": {"other": "metadata"}}
(1 row)

The metadata has been replaced and the pk and user_id remain the same.

[seanh]

👍 Not much to this one. Does it need some tests?

[marcospri]

Not much to this one. Does it need some tests?

Yes, missed those before with the coverage issues, now I get yelled by make coverage 👍