Setting dev_addr to localhost breaks navigation.instant as of 9.4.3

[johnthagen]

Context

Originally discussed at

• Instant loading: Page reload on repeated page link click (Firefox) #6102 (comment)

Bug description

Mkdocs has a dev_addr configuration.

If the user configures this to:

dev_addr: localhost:8001

This breaks the navigation.instant feature. Clicking on links in the navigation or within the pages will not update the contents on screen correctly.

Solution 1

Note, that strictly speaking the Mkdocs docs state that the format should be IP:Port, and localhost is not an IP. Moving this to 127.0.0.1:8001 fixes this issue, but since it used to work, I thought I'd report to see if there are any other underlying issues to address.

Could this instead fail hard with a clear error message?

Solution 2

9.4.2 release does not exhibit this "bug".

Related links

• https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation

Reproduction

9.4.6-dev_addr-localhost-navigation.zip

Steps to reproduce

• Check out: https://github.com/johnthagen/python-blueprint/tree/mkdocs-dev_addr-bug-report
• Install Poetry
• poetry install
• nox -s docs_serve

Browser

Chrome

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.

[alexvoss]

What operating system are you on? Can you confirm that localhost resolves to 127.0.0.1? (e.g., nslookup localhost) What does the network view in the browser's developer tools show?

I built your site but running mkdocs directly, having installed packages only as mkdocs asked for them (not sure what 'poetry' and 'nox' are). It seems to be working fine on my machine, so I recon it is something about your machine or an interaction with other plugins and tools you are using. Hope this helps you narrow it down more.

[johnthagen]

What operating system are you on?

I'm on macOS 13.6.

Can you confirm that localhost resolves to 127.0.0.1?

$ nslookup localhost
Server:		<REDACTED INTERNAL DNS SERVERNAME>
Address:	<REDACTED INTERNAL DNS SERVERNAME>#53

Name:	localhost.REDACTED_COMPANY_PREFIX.REDACTED_TOP_LEVEL_DOMAIN
Address: 127.0.0.1

[iBug]

Doesn't make sense to me. I also could not reproduce on my machine (Ubuntu 22.04, kernel 5.15.0-86-generic, Python 3.10.12, other packages installed latest on a fresh venv). Maybe this is something macOS-specific.

Also it would help better if your ZIP contained a minimal reproduction, not something with poetry or nox or whatever.

[johnthagen]

not something with poetry or nox or whatever.

The zip file itself has a requiremens.lock.txt in it, so that should be usable with bare pip and no need to use Poetry or nox. I included the Poetry/nox instructions for someone who wanted to check it out directly from my branch.

Maybe this is something macOS-specific.

Perhaps the auto-reloader/server works differently on macOS? I've seen similar differences on Flask and other similar auto-reload projects in the past.

Since it worked on 9.4.2 and broke specifically starting at 9.4.3, I thought it was worth reporting in case there is something underlying. If the maintainer would like to close this issue, I'm also fine with that as well, since I was able to fix my particular issue by using 127.0.0.1 instead of localhost.

[iBug]

You skipped the only bold word in my response: Please provide a minimal reproduction so others can actually look into it without various plugins interfering. Also, I reviewed 9.4.2...9.4.3 and did not find anything that makes sense.

Based on those reviews, I'm inclined to believe there's something wrong with another component in your setup, and definitely not the theme's fault. Chances are very likely that you upgraded the faulty component along with the theme from 9.4.2 to 9.4.3.

[squidfunk]

Thanks @alexvoss and @iBug taking the time to help here. I'm closing this as not reproducible for now. If @johnthagen provides a minimal reproduction that allows us to inspect the error, we can reopen this issue.

[johnthagen]

This seems to be fixed when I tried it in 9.4.8 after looking at the changelog. I suspect 87d69a9 was what fixed it.