Hypothesis LMS app saving annotations on URL with a Hypothesis-made URL parameter

[mkdir-washington-edu]

Bug report form

Steps to reproduce

1. Create an LMS app assignment using the URL www.ascd.org/el/articles/6-intrinsic-motivators-to-power-up-your-teaching
2. Create an annotation in that assignment
3. Refresh the page and note the annotation is missing
4. The annotation is saved to:https://www.ascd.org/el/articles/6-intrinsic-motivators-to-power-up-your-teaching?via.client.ignoreOtherConfiguration=1&via.client.openSidebar=1&via.external_link_mode=new-tab&via.client.requestConfigFromFrame.origin=https%3A%2F%2Flms.hypothes.is&via.client.requestConfigFromFrame.ancestorLevel=2&via.blocked_for=lms

Notes:

• creating an assignment out of the URL with the parameter doesn't fix the issue. The URL without the parameter is still displayed in the LMS app while annotations are still saved to the URL with the parameter
• Visiting that page without the URL parameter in the web app in Via does not seem to cause those annotations to be saved with the URL parameter.

Example:
https://hypothesis.instructure.com/courses/266/assignments/2811

Expected behaviour

Annotations should save to the URL without the parameter

Browser/system information

Chrome 98
MacOC 11.6

Possible duplicates?

• 2nd canonical URL on https://cahier1939ms.github.io/texts/translation/ causes Hypothesis to commit incorrect document equivalence #439 - Might be the same / something we need to bear in mind at least

[mkdir-washington-edu]

Ticket: https://app.hubspot.com/contacts/6291320/ticket/788879261/

[mkdir-washington-edu]

Additional note: some screenshots from the user's students show that at one point the students could see each others' annotations.

It looks like this is document_id = 1985147, and it looks like the URL with the parameters is equivalent to the URL without parameters.

It looks like a similar problem happened with doc 2005153 and several other docs.

[jon-betts]

I think I know what's happening here, but not why, or what to do about it yet.

In order for document equivalence to work, we insert:

<link rel="canonical" href="https://www.ascd.org/el/articles/6-intrinsic-motivators-to-power-up-your-teaching">

But the original page inserts one as well:

<link rel="canonical" href="http://localhost:9085/proxy/mp_/https://www.ascd.org/el/articles/6-intrinsic-motivators-to-power-up-your-teaching?via.client.ignoreOtherConfiguration=1&amp;via.client.openSidebar=1&amp;via.external_link_mode=new-tab&amp;via.client.requestConfigFromFrame.origin=http%3A%2F%2Flocalhost%3A8001&amp;via.client.requestConfigFromFrame.ancestorLevel=2&amp;via.blocked_for=lms">

I don't know exactly how this is happening. One guess is it's dynamically reading the location and putting it in? I don't think we are doing this, but I can check.

I suspect what's happening is the last canonical declaration "wins" and ends up being the one all the annotations are added to.

[jon-betts]

I've added a POC PR to show how we can interact with the canonical values declared by pages. This PR completely destroys it, and this causes all annotations to re-appear.

I don't think this is necessarily the best way to go though.

[jon-betts]

I think this is fixed now? It's a bit hard to say as from the UK there are two separate Cookie popups that render the page mostly un-usable.

[jon-betts]

Hmm, I'm not so sure. I'm still seeing broken canonical values...

edit: A bit more detail here. The backend is writing the canonical URL correctly, but something is rewriting it back to the original location (in Via). A few options were discussed, but a potential "fix" which is easy to do is to completely destroy the tag when rewriting the page.

We can delete all attributes from it (although we can't get rid of it completely). This would result in an empty <link/> tag, which wouldn't have anything that could be rewritten. This would give you the same experience as other pages in Via with no canonical tag, but a potentially different experience from visiting the same page with the extension, which would respect the canonical tag. So it's not ideal.

On the other hand this is totally broken right now, so this seems like we could put it in as an interim fix.

[jon-betts]

It seems like assignments made for:

• https://www.ascd.org/el/articles/6-intrinsic-motivators-to-power-up-your-teaching

End up with:

• https://www.ascd.org/el/articles/6-intrinsic-motivators-to-power-up-your-teaching?via.client.ignoreOtherConfiguration=1&via.client.openSidebar=1&via.external_link_mode=new-tab&via.client.requestConfigFromFrame.origin=https%3A%2F%2Flms.hypothes.is&via.client.requestConfigFromFrame.ancestorLevel=2&via.blocked_for=lms

You can see the full URL there in the client help info.

This seems to have the canonical URL back as well:

• https://lms-viahtml.hypothes.is/proxy/mp_/https://www.ascd.org/el/articles/6-intrinsic-motivators-to-power-up-your-teaching?via.client.ignoreOtherConfiguration=1&via.client.openSidebar=1&via.external_link_mode=new-tab&via.client.requestConfigFromFrame.origin=https%3A%2F%2Flms.hypothes.is&via.client.requestConfigFromFrame.ancestorLevel=2&via.blocked_for=lms

[mkdir-washington-edu]

Testing this again here: https://hypothesis.instructure.com/courses/359/assignments/7732

1. Made an assignment using www.ascd.org/el/articles/6-intrinsic-motivators-to-power-up-your-teaching
2. Created an annotation in that assignment
3. Refreshed the page
4. annotation was not missing on refresh
5. But the annotation is still being saved to: https://www.ascd.org/el/articles/6-intrinsic-motivators-to-power-up-your-teaching?via.client.ignoreOtherConfiguration=1&via.client.openSidebar=1&via.external_link_mode=new-tab&via.client.requestConfigFromFrame.origin=https%3A%2F%2Flms.hypothes.is&via.client.requestConfigFromFrame.ancestorLevel=2&via.blocked_for=lms

Document id = 1985147.

This no longer appears to be a document equivalence issue, we're still saving the URL incorrectly.