Built-in privacy plugin does not replace all external URLs

[LarsWegm]

Context

No response

Bug description

With mkdocs-material-9.6.5 the built-in privacy plugin does not replace all external URLs. For example, fonts and stylesheets from fonts.gstatic.com are not replaced, but the Javascript for mermaid.js from unpkg.com is replaced. It was working fine in version 9.6.4.

Network connections with privacy plugin and mkdocs-material 9.6.5:

Network connections with privacy plugin and mkdocs-material 9.6.4:

Related links

• Built-in privacy plugin
• Privacy plugin crashes on HTTP errors #8012

Reproduction

9.6.5-privacy-plugin-broken.zip

Steps to reproduce

1. Run mkdocs serve or mkdocs build with privacy plugin enabled
2. Open network monitor in browser tools
3. Navigate to mkdocs page and observe the network connections

Browser

No response

Before submitting

• I have read and followed the bug reporting guidelines.
• I have attached links to the documentation, and possibly related issues and discussions.
• I assure that I have removed all customizations before submitting this bug report.
• I have attached a .zip file with a minimal reproduction using the built-in info plugin.

[squidfunk]

Thanks for reporting. Looping in @Lucas-C, who did the work on the privacy plugin fixing #8012. Lucas, could I maybe ask you to take a look why this happens? It might be clashing with the fixes that were provided in 2e837fa.

[Lucas-C]

Sure, I can give it a look 🙂
Not right now though, but I'll try to investigate on Sunday or Monday.

Also, IMHO, having unit tests would reduce the risk of regression like this a lot 😅

[kamilkrzyskow]

The issue is here:

mkdocs-material/material/plugins/privacy/plugin.py

Lines 388 to 389 in 3a7cc2a

	if not self._fetch(file, config):
	return None

Looks like some unfinished thought. Previously the _fetch function had no error handling and returned None at the end of the function by default. Now it supports error handling and does return early in case of an network error:

mkdocs-material/material/plugins/privacy/plugin.py

Lines 434 to 436 in 3a7cc2a

	except Exception as error:
	log.warning(f"Couldn't retrieve {file.url}: {error}")
	return

However, it still returns None at the end, so that conditional will always be True and therefore return None.
Therefore, the replace won't resolve the file because file is None:

mkdocs-material/material/plugins/privacy/plugin.py

Lines 314 to 316 in 3a7cc2a

	file = self._queue(url, config)
	if file:
	el.set("href", resolve(file))

I'm not sure how to properly add handling for this. The _fetch function could start returning a boolean, return True at the end of the function, and return False when handling the early escape after the network error, and the conditional would check for

if self._fetch(file, config) is False: 
     return None  

Not sure if that was the goal ✌️

[squidfunk]

Thanks for investigating @kamilkrzyskow! I'll take a look.

Also, IMHO, having unit tests would reduce the risk of regression like this a lot 😅

I agree. Please see my comment on your last remark regarding unit tests ☺️

[squidfunk]

Fixed in 523922b. @kamilkrzyskow was right and the fix was simple – testing shows that files are now correctly replaced again. Also, I've added a request that 404s to check whether the error handling still works:

[squidfunk]

Released as part of 9.6.6.

[Lucas-C]

I agree. Please see my comment on your last remark regarding unit tests ☺️

Yes, I remember, I just wanted to mention it again 😅

---

Good job on analysing & fixing this @kamilkrzyskow & @squidfunk 👍
Thanks!

[LarsWegm]

Thanks to everyone for the quick fix!