fix: implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines, fixes #2817 #4805

rfay · 2023-04-05T14:47:15Z

The Issue

ddev's management of /etc/hosts file could use one line per host, instead of putting all on one line #2817

I thought we were already limiting the number of hosts per line in /etc/hosts, but it turns out it required extra code.

See https://github.com/goodhosts/hostsfile

How This PR Solves The Issue

Minor change to goodhosts/hostsfile usage to implement 9-hosts-per-line limit

We may want to wait on this because of non-critical

Limiting hosts per line works for first line, but after that each item goes on its own line goodhosts/hostsfile#51

Manual Testing Instructions

for item in 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15; do 
  sudo ddev hostname a$item.ddev.site 127.0.0.1
done

Then inspect hosts file. This needs to be done on macOS, Linux, and traditional Windows.

Automated Testing Overview

We don't test this behavior I don't think because requires sudo

Release/Deployment Notes

josefglatz · 2023-04-06T09:01:11Z

Tested locally with real world /etc/hosts file

here are the results:

⁇ Broadcast host line was moved to first line (was before on penultimate line)
⁇ IPv6 line ::1 localhost was moved to 2nd line (was before on last line)
❌ Executing the following test command resulting in a broadcast line 255.255.255.255 with a2.ddev.site 🤨
❤️ All other entries/lines were adopted correct from my POV

Test command:

for item in 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15; do 
  sudo ddev hostname a$item.ddev.site 127.0.0.1
done

Resulting /etc/hosts under macOS Ventura (project related entries where masked due to privacy)

Other infos

What problems does occur without this fix?

macOS Safari can not handle too long lines in /etc/hosts and will not read domains on the end of the line (e.g. 127.0.0.0.1 entry with ~100 domain names)

Apple Bug Report?

I already created a bug report. If I get any response I let you know here in this PR/issue :-)

rfay · 2023-04-06T14:04:37Z

Did it really change "broadcast" to "boardcast" ?

I do see this in goodhosts issue queue:

HostsPerLine is destructive goodhosts/hostsfile#40

Please link your safari issue with Apple here.

rfay · 2023-04-06T14:06:29Z

For test purposes, here's a plain vanilla macOS starter version of /etc/hosts:

##
# Host Database
#
# localhost is used to configure the loopback interface
# when the system is booting.  Do not change this entry.
##
127.0.0.1	localhost
255.255.255.255	broadcasthost
::1             localhost

josefglatz · 2023-04-06T14:30:27Z

Did it really change "broadcast" to "boardcast" ?

Sorry, was just a typo. See the screenshot in my comment.

josefglatz · 2023-04-06T14:31:25Z

I have reported the problem at Apple: Feedback-ID FB12100456

rfay · 2023-04-06T16:25:32Z

Opened

Calling HostsPerLine() before Add() results in a panic with plain vanilla macOS hosts file goodhosts/hostsfile#42

And created demonstration repository at goodhosts/hostsfile#42

rfay · 2023-04-06T16:34:21Z

Please test with the updated build here. After running the suggested test against a stock macOS hosts file I see

255.255.255.255 broadcasthost
::1 localhost

127.0.0.1 a1.ddev.site a10.ddev.site a11.ddev.site a12.ddev.site a13.ddev.site a14.ddev.site a15.ddev.site a2.ddev.site
127.0.0.1 a3.ddev.site a4.ddev.site a5.ddev.site a6.ddev.site a7.ddev.site a8.ddev.site a9.ddev.site localhost

Default hosts file is at https://raw.githubusercontent.com/rfay/goodhostsbug/main/hosts

After changing the example to remove:

for item in 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15; do    sudo ddev hostname -r a$item.ddev.site 127.0.0.1; done

I see this:

255.255.255.255 broadcasthost
::1 localhost

127.0.0.1 localhost

I don't like that the comments have been removed, see

HostsPerLine is destructive goodhosts/hostsfile#40

rfay · 2023-04-06T18:12:44Z

@josefglatz if you have trouble again, please provide the starting version of your /etc/hosts so I can experiment with it as well. Thanks!

rfay · 2023-04-13T16:59:03Z

I'm not sure this is going to be an acceptable approach @josefglatz because of the rearranging of the file and loss of comments. Maybe we'll have to wait until something happens with

HostsPerLine is destructive goodhosts/hostsfile#40

However, I'd love it if you could test it anyway...

rfay · 2023-04-28T00:13:48Z

No response from @josefglatz on this at this point, and I'm not very happy about the idea idea of completely rewriting hosts file. Closing for now, happy to reopen and to discuss. I'm following the issue,

HostsPerLine is destructive goodhosts/hostsfile#40

josefglatz · 2023-05-08T06:53:53Z

I tested a little bit. But I can't figure out how to adopt this to make this more bulletproof.

Should we add a note about this in the DDEV documentation @rfay ?

rfay · 2023-05-08T13:52:34Z

You didn't respond on the PR, would have loved to have your input on that.

I think there's code in there to warn windows users, but there's no way to warn safari users.

A docs PR would be fine.

rfay · 2023-09-29T20:27:40Z

Although

Calling HostsPerLine() before Add() results in a panic with plain vanilla macOS hosts file goodhosts/hostsfile#42

is being worked on at this point, I'm not sure that

HostsPerLine is destructive goodhosts/hostsfile#40

will get attention, but it might!

See goodhosts/hostsfile#42

rfay · 2023-10-28T17:23:28Z

Reopened, as

HostsPerLine is destructive goodhosts/hostsfile#40
is fixed, yay!

github-actions · 2023-10-28T18:49:25Z

Download the artifacts for this pull request:

See Testing a PR

rfay · 2023-10-29T19:02:40Z

@josefglatz Please take a look at this again, I think it's working great with the excellent fixes to goodhosts/hostsfile, thanks! Artifacts for testing in #4805 (comment)

stasadev

Tested it on Linux:

$ cat /etc/hosts
# Host addresses
127.0.0.1 localhost
127.0.1.1 my-machine-name
::1 localhost ip6-localhost ip6-loopback
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters

$ for item in 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15; do sudo ddev hostname a$item.ddev.site 127.0.0.1; done
$ cat /etc/hosts
# Host addresses
127.0.0.1 localhost a1.ddev.site a2.ddev.site a3.ddev.site a4.ddev.site a5.ddev.site a6.ddev.site a7.ddev.site
127.0.0.1 a8.ddev.site a9.ddev.site a10.ddev.site a11.ddev.site a12.ddev.site a13.ddev.site a14.ddev.site a15.ddev.site
127.0.1.1 my-machine-name
::1 localhost ip6-localhost ip6-loopback
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters

$ for item in 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15; do sudo ddev hostname -r a$item.ddev.site 127.0.0.1; done
$ cat /etc/hosts
# Host addresses
127.0.0.1 localhost
127.0.1.1 my-machine-name
::1 localhost ip6-localhost ip6-loopback
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters

rfay · 2023-11-01T17:08:13Z

This can now be tested in HEAD, using https://ddev.readthedocs.io/en/latest/developers/building-contributing/#testing-latest-commits-on-head

rfay · 2023-11-01T17:24:48Z

I also did a prerelease that can be used for testing this, https://github.com/ddev/ddev/releases/tag/v1.22.5-alpha1

josefglatz · 2023-11-21T15:55:57Z

Tested the feature successfully. Sorry for the delay @rfay

rfay · 2023-11-21T16:04:40Z

Yay, thanks!

rfay requested a review from a team as a code owner April 5, 2023 14:47

rfay marked this pull request as draft April 13, 2023 16:59

rfay changed the title ~~Implement limit on number of hosts per line in /etc/hosts~~ Implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines Apr 26, 2023

rfay closed this Apr 28, 2023

rfay changed the title ~~Implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines~~ Implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines, fixes #2817 Oct 27, 2023

rfay added 3 commits October 28, 2023 11:17

Implement limit on number of hosts per line in /etc/hosts

6593bd1

Move HostsPerLine() to after add

b71df95

See goodhosts/hostsfile#42

Update goodhosts/hostsfile to 0.1.4

52429e4

rfay reopened this Oct 28, 2023

rfay force-pushed the 20230405_hosts_limit branch from 2a53837 to 52429e4 Compare October 28, 2023 17:22

rfay changed the title ~~Implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines, fixes #2817~~ fix: implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines, fixes #2817 Oct 28, 2023

This was referenced Oct 28, 2023

HostsPerLine is destructive goodhosts/hostsfile#40

Closed

Limiting hosts per line works for first line, but after that each item goes on its own line goodhosts/hostsfile#51

Closed

Start using go v1.21 for toolchain directive

41dc144

github-actions bot added bugfix dependencies Pull requests that update a dependency file labels Oct 28, 2023

rfay added 3 commits October 28, 2023 12:50

remove go toolchain from go.mod

47b4961

Bump hostsfile to 0.1.5

c535c12

use goodhosts/hostsfile 0.1.6

ebd0587

ddev deleted a comment from github-actions bot Oct 29, 2023

rfay marked this pull request as ready for review October 29, 2023 19:02

rfay requested a review from a team as a code owner October 29, 2023 19:02

rfay requested a review from stasadev October 31, 2023 22:39

stasadev approved these changes Nov 1, 2023

View reviewed changes

rfay merged commit faff807 into ddev:master Nov 1, 2023
27 checks passed

rfay deleted the 20230405_hosts_limit branch November 1, 2023 17:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines, fixes #2817 #4805

fix: implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines, fixes #2817 #4805

rfay commented Apr 5, 2023 •

edited

josefglatz commented Apr 6, 2023 •

edited

rfay commented Apr 6, 2023

rfay commented Apr 6, 2023 •

edited

josefglatz commented Apr 6, 2023 •

edited

josefglatz commented Apr 6, 2023

rfay commented Apr 6, 2023

rfay commented Apr 6, 2023 •

edited

rfay commented Apr 6, 2023

rfay commented Apr 13, 2023

rfay commented Apr 28, 2023

josefglatz commented May 8, 2023

rfay commented May 8, 2023 •

edited

rfay commented Sep 29, 2023

rfay commented Oct 28, 2023

github-actions bot commented Oct 28, 2023 •

edited

rfay commented Oct 29, 2023

stasadev left a comment

rfay commented Nov 1, 2023

rfay commented Nov 1, 2023

josefglatz commented Nov 21, 2023

rfay commented Nov 21, 2023

fix: implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines, fixes #2817 #4805

fix: implement limit on number of hosts per line in /etc/hosts because Safari has problems with long lines, fixes #2817 #4805

Conversation

rfay commented Apr 5, 2023 • edited

The Issue

How This PR Solves The Issue

Manual Testing Instructions

Automated Testing Overview

Related Issue Link(s)

Release/Deployment Notes

josefglatz commented Apr 6, 2023 • edited

Tested locally with real world /etc/hosts file

here are the results:

Other infos

What problems does occur without this fix?

Apple Bug Report?

rfay commented Apr 6, 2023

rfay commented Apr 6, 2023 • edited

josefglatz commented Apr 6, 2023 • edited

josefglatz commented Apr 6, 2023

rfay commented Apr 6, 2023

rfay commented Apr 6, 2023 • edited

rfay commented Apr 6, 2023

rfay commented Apr 13, 2023

rfay commented Apr 28, 2023

josefglatz commented May 8, 2023

rfay commented May 8, 2023 • edited

rfay commented Sep 29, 2023

rfay commented Oct 28, 2023

github-actions bot commented Oct 28, 2023 • edited

rfay commented Oct 29, 2023

stasadev left a comment

Choose a reason for hiding this comment

rfay commented Nov 1, 2023

rfay commented Nov 1, 2023

josefglatz commented Nov 21, 2023

rfay commented Nov 21, 2023

rfay commented Apr 5, 2023 •

edited

josefglatz commented Apr 6, 2023 •

edited

rfay commented Apr 6, 2023 •

edited

josefglatz commented Apr 6, 2023 •

edited

rfay commented Apr 6, 2023 •

edited

rfay commented May 8, 2023 •

edited

github-actions bot commented Oct 28, 2023 •

edited