Search not working in 1.2.0 in environments without web access

tmct commented 1 year ago

Problem

Hi,

When I upgrade to 1.2.0, the "search" feature stops working in airgapped environments. When a search is initiated, it "spins" but does not finish.

Also observed: 1) on load, the webpage tries to access https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js upon load, and this fails in environments with no internet access, as expected 2) "Uncaught ReferenceError: jQuery is not defined" happens when you initiate a search

Reproducible Project

Cannot share, sorry - but it shouldn't matter

Error Logs/Results

See above

Expected Results

Search completes as expected

Environment Info

Python Version: 3.8 and 3.9
Sphinx Version: 6.1.3
RTD Theme Version: 1.2.0

benjaoming commented 1 year ago

@tmct we forced the version of sphinxcontrib-jquery to exclude 3.0.0 because there were incoming reports that jQuery wasn't loaded in local builds because of an SRI integrity check. See: https://github.com/readthedocs/sphinx_rtd_theme/issues/1420

If you can force-feed pip sphinxcontrib-jquery==3.0.0, you should be able to serve an airgapped build.

This will be finally fixed by a new version of sphinxcontrib-jquery: https://github.com/sphinx-contrib/jquery/pull/14

tmct commented 1 year ago

Thanks very much! I'll keep an eye on that sphinxcontrib-jquery change.

benjaoming commented 1 year ago

@tmct you can also try reinstalling now, that should give you sphinxcontrib-jquery==4.1 which has resolved the issue generally.

gherceg commented 1 year ago

@benjaoming we are experiencing a similar issue, but after upgrading sphinxcontrib-jquery to 4.1 (with sphinx==6.1.3 and sphinx-rtd-theme==1.2), the "Uncaught ReferenceError: jQuery is not defined" error still occurs when using the search bar.

benjaoming commented 1 year ago

@gherceg thanks for the feedback!! do you have a build log, a link to the documentation and/or a git repo that I can have a look at?

gherceg commented 1 year ago

Yeah of course. commcare-hq is the repository, and the docs are here, but notably that docs build is still running sphinxcontrib-jquery==2.0.0, with the same versions for sphinx and sphinx-rtd-theme mentioned above.

benjaoming commented 1 year ago

@gherceg ah! I recognize this issue. Default setups aren't affect by this: We removed html_theme_path from the injected default configuration for Sphinx projects on Read the Docs (because this setting breaks stuff), but very old instructions mentioned to define html_theme_path, so that's probably where you originally got it into your own conf.py. The setting unfortunately switches off the theme's ability to automatically enable the sphinxcontrib-jquery extension, so you either have to enable the extension manually or remove html_theme_path from conf.py. Since it's unnecessary to have this setting, you can just remove it as suggested in https://github.com/dimagi/commcare-hq/pull/32760 :+1:

(after multiple edits: I think it makes sense now, but LMK if there's something unclear)