Publish annotation tasks to an authority queue #9402
Conversation
| task_name: str | ||
|
|
||
|
|
||
| class AnnotationAuthorityQueueService: |
There was a problem hiding this comment.
Maybe we wouldn't need a separate service for this, but as this is going to be only used by LMS for now it isolates it from the rest of the codebase.
|
|
||
|
|
||
| @subscriber(AnnotationEvent) | ||
| def publish_annotation_event_for_authority(event): |
There was a problem hiding this comment.
Again, we do another level of indirection here, the subscriber creates a celery task, that way if this LMS only feature creates any problems the annotations will be created fine.
| @celery.task | ||
| def publish_annotation_event_for_authority(event_action, annotation_id): | ||
| """Optionally publish an annotation event to the authority's message queue.""" | ||
| celery.request.find_service(AnnotationAuthorityQueueService).publish( |
There was a problem hiding this comment.
The celery task just calls the service method, not much to see here.
| if not authority_queue_config: | ||
| return | ||
|
|
||
| if event_action != "create" or not annotation.mentions: |
There was a problem hiding this comment.
This limits the amount of messages created by this to... just us testing for now.
| self, config_json: str | None | ||
| ) -> dict[str, AuthorityQueueConfiguration]: | ||
| """Parse the authority queue config JSON string into dictionary by authority name.""" | ||
| if not config_json: |
There was a problem hiding this comment.
Being careful, if no config, broken config or any other issue, we just log and continue.
There was a problem hiding this comment.
This is only checked once on the server instantiation.
marcospri
force-pushed
the
publisha-annotation-messages
branch
2 times, most recently
from
374d257 to
d040991
Compare
Based on a per authority configuration publish new annotation messages that containt mentions to a queue. The motivation for this is to support mention notification for LMS users.
marcospri
force-pushed
the
publisha-annotation-messages
branch
from
d040991 to
ee713cc
Compare
Based on a per authority configuration publish new annotation messages that contain mentions to a queue.
The motivation for this is to support mention notification for LMS users.
See the design document over: https://docs.google.com/document/d/1tOTw-9bqCgM1bp0h2QsjsGKl0mtGh2lnpdv5oHYIj8E
Testing
https://github.com/hypothesis/devdata/pull/116/files#diff-fe2be50e5855174f3ad7a3348f4381308c4b70bacd6eb95fa47342f448ad1728R3
Checkout this LMS branch Consume messages about annotations published by H lms#7051
Restart H's and LMS's
make devso celery changes are picked upMake an annotation on a assignment
https://hypothesis.instructure.com/courses/125/assignments/873