Broken rendering?

[amotl]

Hi there,

@proddata just shared this screenshot with me. It shows scrambled garbage output when visiting the documentation space.

According to his report, it only happens on https://crate.io/docs/crate/tutorials/. He has been able to verify it on two different devices using two different internet connections. On the other hand, I have not been able to reproduce it in any way.

With kind regards,
Andreas.

[amotl]

Maybe it is related to #261 in any way? As outlined at #261 (review), the response body of https://crate.io/navi-promo.php is not actually empty (Content-Length: 23) but apparently contains some newline or other weird characters.

If that also happens with https://crate.io/navi-newsletter.php, there might be a chance that those characters have been introduced by adding the respective ESI snippets.

/cc @msbt

[msbt]

Ah yes, I've only created the PR but it's not merged and the new config didn't make it to fastly just yet. I've renamed the file to remove the issue and flushed the cache so it will disappear. This will work when the fastly config gets an update, sorry for that :/

[msbt]

Ok something is not right, there are several errors on various docs pages. We meant to test the new version on a single repo, can we roll back and do that to see what's going on here? @amotl @norosa

getting
Uncaught TypeError: $.cookie is not a function
two more json errors and also
Error loading Read the Docs footer readthedocs-doc-embed.js
and
Error registering page view readthedocs-doc-embed.js

[msbt]

The initial rendering issue should be resolved (this happens when you try to include an already gzipped document, that's why the Fastly thing should have happened first. I've added an empty file as include and will rename the proper one when the new config is live. Either way, there are some other issues mentioned above that need addressing.

[msbt]

@amotl I did a bit of comparing and it seems one of the issues is that we load jquery too late, this needs to be loaded before the bundled js file which includes some jquery functions (e.g. the cookie thing). The others could be also related to that, since there are some jquery messages in the debugger.

[amotl]

Thank you for figuring this out! We probably missed this detail because the corresponding code has not been run in the local sandbox when just looking at the examples, right?

[msbt]

Yes, the cookie thing is only used when a segment id is supplied ({% if theme_tracking_segment_id %} - so only on production) and rtd is probably only in use when rendered there, at least I think I didn't see any errors while testing.

[amotl]

There might be a problem webpack not exposing the $.cookie symbol properly. However, I found it is available as jquery.cookie. #279 brings in a corresponding patch.

[amotl]

The Uncaught TypeError: $.cookie is not a function error should be gone now. I verified it on:

• https://crate.io/docs/crate/tutorials/
• https://crate.io/docs/crate/howtos/
• https://crate.io/docs/crate/reference/