Feat: expose server on local network with new --host flag #2760

bholmesdev · 2022-03-10T21:49:20Z

Changes

Introduce new --host flag to mirror Vite's config option
- When --host is absent, the network URL is not exposed on your network
- When --host is present, the network URL is exposed at a default URL
- When --host [custom host] is present, the network URL is exposed at [custom host]
- (deprecated) When --hostname [custom host] is present, the network URL is also exposed at [custom host]
Deprecate --hostname while maintaining functionality

Testing

Added unit tests for current and legacy flags
Added unit tests for preview command alongside dev

Docs

Updated configuration and CLI references on docs.
PR here!

changeset-bot · 2022-03-10T21:49:23Z

🦋 Changeset detected

Latest commit: fdf08de

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
astro	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

packages/astro/src/@types/astro.ts

FredKSchott · 2022-03-10T23:22:10Z

packages/astro/src/@types/astro.ts

 		 * @type {string}
-		 * @default `'localhost'`
+		 * @default `localhost`
+		 * @deprecated Use --host instead


how should we handle this in the docgen script?

I think my suggestion would be to ignoring it completely, and add a note in the host @description body that it used to be called hostname.

Made that refactor. Waiting for the docgen updates to merge, but will verify my > blockquote looks right once those are in 👍

FredKSchott · 2022-03-10T23:26:29Z

packages/astro/src/cli/index.ts

@@ -38,6 +38,7 @@ function printHelp() {
 	title('Flags');
 	table(
 		[
+			['--host [optional host address]', 'Expose server on network'],


nit: this feels a little verbose for just a summary. What about just '--host [address]' or '--host [ip]'? imo advanced details can be left to the documentation.

Fair! Just wanted to clarify that it's optional, so users know --host could be a boolean flag. Maybe --host [optional IP] is a good compromise?

☝️ Went ahead with that refactor. Lmk if you like it!

FredKSchott · 2022-03-10T23:28:57Z

packages/astro/src/core/dev/index.ts

 	const site = config.buildOptions.site ? new URL(config.buildOptions.site) : undefined;
 	info(
 		options.logging,
 		null,
-		msg.devStart({ startupTime: performance.now() - devStart, port: address.port, localAddress, networkAddress: address.address, site, https: !!viteUserConfig.server?.https })
+		msg.devStart({ startupTime: performance.now() - devStart, port: address.port, localAddress, isNetworkExposed, site, https: !!viteUserConfig.server?.https })


I thought that --host 1.2.3.4 would work. How does devStart know to show the correct http://1.2.3.4 URL in the console log if we don't share the host string? Is os.networkInterfaces() that smart?

Yep, os.networkInterfaces really does cover us! This is taken directly from Vite's CLI.
For instance, passing my device IP will only expose the server on my network (not localhost or 0.0.0.0):

packages/astro/src/core/dev/util.ts

FredKSchott

Looking good! Left a few comments

natemoo-re

Looks good other than a question around passing --host 127.0.0.1 explicitly

examples/minimal/astro.config.mjs

packages/astro/src/core/dev/util.ts

natemoo-re

LGTM once tests are passing!

natemoo-re · 2022-03-11T21:54:35Z

packages/astro/src/core/messages.ts

+import type { AddressInfo } from 'net';
+import type { AstroConfig } from '../@types/astro';


Super small nit: we always do import type at the top of the file.

No need to fix, just FYI.

packages/astro/test/cli.test.js

natemoo-re · 2022-03-11T22:24:19Z

…2760) * feat: update config to support bool --hostname * fix: show localhost for --hostname=true * feat: address logging feature parity w/ Vite * chore: update type docs * refactor: extract local, network prefs to variable * feat: add --host to --help output * feat: deprecate --hostname, add --host * feat: add --host tests * feat: update preview to support new flags * fix: show --host in dev server log * feat: update config tests for --host flag * chore: test lint * chore: update lock with new fixture * chore: add changeset * refactor: add more details to JSdocs * fix: update path tests * feat: only expose when --host is not local * fix: make flag --help less verbose * fix: address @types comments * fix: lint * chore: remove unused import * fix: use host flag for config test * fix: ensure local logs come before network * refactor: switch up that network logging one last time! * feat: update unit tests * chore: remove debugging block * fix: only parse network logs if network is present

github-actions bot added pkg: astro Related to the core `astro` package (scope) test labels Mar 10, 2022

FredKSchott reviewed Mar 10, 2022

View reviewed changes

packages/astro/src/@types/astro.ts Outdated Show resolved Hide resolved

FredKSchott reviewed Mar 10, 2022

View reviewed changes

packages/astro/src/core/dev/util.ts Outdated Show resolved Hide resolved

FredKSchott reviewed Mar 10, 2022

View reviewed changes

packages/astro/src/core/dev/util.ts Show resolved Hide resolved

FredKSchott reviewed Mar 10, 2022

View reviewed changes

github-actions bot added the pkg: example Related to an example package (scope) label Mar 11, 2022

bholmesdev force-pushed the feat/expose-local-network-on-host-flag branch 3 times, most recently from 777554f to e2aef14 Compare March 11, 2022 17:11

bholmesdev added 16 commits March 11, 2022 13:03

feat: update config to support bool --hostname

08898e4

fix: show localhost for --hostname=true

c004d55

feat: address logging feature parity w/ Vite

4df8154

chore: update type docs

3579ebe

refactor: extract local, network prefs to variable

0b507be

feat: add --host to --help output

06ddb45

feat: deprecate --hostname, add --host

76c4bcc

feat: add --host tests

2e165f9

feat: update preview to support new flags

5f2ae80

fix: show --host in dev server log

d153b59

feat: update config tests for --host flag

dd14845

chore: test lint

e005346

chore: update lock with new fixture

d2fbaa1

chore: add changeset

f5f7c2d

refactor: add more details to JSdocs

86ac493

fix: update path tests

4004d6b

bholmesdev added 7 commits March 11, 2022 13:03

feat: only expose when --host is not local

6c2554d

fix: make flag --help less verbose

df5d70c

fix: address @types comments

30c125c

fix: lint

b1c50d6

chore: remove unused import

32ad433

fix: use host flag for config test

e966d3d

fix: ensure local logs come before network

6bea3bb

bholmesdev force-pushed the feat/expose-local-network-on-host-flag branch from e2aef14 to 6bea3bb Compare March 11, 2022 18:03

bholmesdev requested a review from FredKSchott March 11, 2022 18:32

natemoo-re reviewed Mar 11, 2022

View reviewed changes

examples/minimal/astro.config.mjs Outdated Show resolved Hide resolved

packages/astro/src/core/dev/util.ts Show resolved Hide resolved

natemoo-re added this to the 0.24 milestone Mar 11, 2022

bholmesdev added 3 commits March 11, 2022 16:11

refactor: switch up that network logging one last time!

0ff49d6

feat: update unit tests

d21e981

chore: remove debugging block

4ed56cd

github-actions bot removed the pkg: example Related to an example package (scope) label Mar 11, 2022

natemoo-re approved these changes Mar 11, 2022

View reviewed changes

natemoo-re reviewed Mar 11, 2022

View reviewed changes

packages/astro/test/cli.test.js Show resolved Hide resolved

fix: only parse network logs if network is present

fdf08de

bholmesdev force-pushed the feat/expose-local-network-on-host-flag branch from cce64e8 to fdf08de Compare March 11, 2022 22:04

bholmesdev merged commit 77b9c95 into main Mar 11, 2022

bholmesdev deleted the feat/expose-local-network-on-host-flag branch March 11, 2022 22:25

github-actions bot mentioned this pull request Mar 11, 2022

[ci] release #2770

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: expose server on local network with new --host flag #2760

Feat: expose server on local network with new --host flag #2760

bholmesdev commented Mar 10, 2022 •

edited

changeset-bot bot commented Mar 10, 2022 •

edited

FredKSchott Mar 10, 2022

bholmesdev Mar 11, 2022

FredKSchott Mar 10, 2022

bholmesdev Mar 11, 2022

bholmesdev Mar 11, 2022

FredKSchott Mar 10, 2022

bholmesdev Mar 11, 2022

FredKSchott Mar 11, 2022

FredKSchott left a comment

natemoo-re left a comment

natemoo-re left a comment

natemoo-re Mar 11, 2022

natemoo-re commented Mar 11, 2022 •

edited

		import type { AddressInfo } from 'net';
		import type { AstroConfig } from '../@types/astro';

Feat: expose server on local network with new --host flag #2760

Feat: expose server on local network with new --host flag #2760

Conversation

bholmesdev commented Mar 10, 2022 • edited

Changes

Testing

Docs

changeset-bot bot commented Mar 10, 2022 • edited

🦋 Changeset detected

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FredKSchott left a comment

Choose a reason for hiding this comment

natemoo-re left a comment

Choose a reason for hiding this comment

natemoo-re left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natemoo-re commented Mar 11, 2022 • edited

bholmesdev commented Mar 10, 2022 •

edited

changeset-bot bot commented Mar 10, 2022 •

edited

natemoo-re commented Mar 11, 2022 •

edited