Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Forward annotation metadata from the LMS backend to the H backend via the client #5698

Closed
marcospri opened this issue Sep 14, 2023 · 1 comment
Closed

Forward annotation metadata from the LMS backend to the H backend via the client #5698

marcospri opened this issue Sep 14, 2023 · 1 comment
Assignees
@robertknight

Comments

@marcospri
Copy link
Member

marcospri commented Sep 14, 2023 •
edited
Loading

The LMS backend is going to generate an opaque set of metadata to store alongside annotations.

To communicate that to the H's service in the LMS context the LMS backend is going to expose a config option to the LMS front end which should be used by the client to finally pass it to the H's server.

Based on:

hypothesis/h#8175
hypothesis/h#8182
#5697

#5697 defines a new client configuration options which includes includes an opaque dictionary with LMS specific data.

That dictionary should be forwarded to H's API as the metadata key in the API, following the changes made in hypothesis/h#8175
@robertknight
Copy link
Member

See https://hypothes-is.slack.com/archives/C4K6M7P5E/p1696584492777979 for updated details on what the LMS frontend and client need to do.

robertknight added a commit to hypothesis/client that referenced this issue Oct 19, 2023
@robertknight
Save context metadata provided by LMS app with new annotations
6174821 
When the embedder frame (eg. our LMS app) provides context metadata to be saved
with annotations via the `annotationMetadata` config property, save that with
new annotations in the `metadata` field.

We add this information only when an annotation is created, and not on
subsequent edits, because the main use case in the LMS context is to record the
assignment where the annotation was created. If the user edits that annotation
subsequently in another assignment, we don't want it to be "moved" by updating
the `metadata` field.

Part of hypothesis/lms#5698
@robertknight robertknight mentioned this issue Oct 19, 2023
Merged
robertknight added a commit to hypothesis/client that referenced this issue Oct 19, 2023
@robertknight
Save context metadata provided by LMS app with new annotations
4fe2f5b 
When the embedder frame (eg. our LMS app) provides context metadata to be saved
with annotations via the `annotationMetadata` config property, save that with
new annotations in the `metadata` field.

We add this information only when an annotation is created, and not on
subsequent edits, because the main use case in the LMS context is to record the
assignment where the annotation was created. If the user edits that annotation
subsequently in another assignment, we don't want it to be "moved" by updating
the `metadata` field.

Part of hypothesis/lms#5698
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@robertknight robertknight

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@robertknight @marcospri @acelaya