Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Check port usage correctly (fix #6519) #6523

Closed
wants to merge 4 commits into from
Closed

fix: Check port usage correctly (fix #6519) #6523

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
da883b1
feat: Check port usage correctly
Jan 16, 2022
1fb9679
chore: Move test file
Jan 16, 2022
8b2b8cd
test: modified test file
Jan 17, 2022
2e14303
test: Add index.html
Jan 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions packages/playground/preview/__tests__/preview.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import { httpServerStart } from 'vite/src/node/http'
import { resolveConfig } from 'vite/src/node'
import { createServer } from 'http'

describe('start preview server', () => {
test('[strictPort=false, host=127.0.0.1] should use another port when already start a server on localhost.', async () => {
const originalPort = 5000
const server = createServer()
server.listen(originalPort, 'localhost')

const testServer = createServer()
const config = await resolveConfig({}, 'serve', 'production')
const port = await httpServerStart(testServer, {
port: originalPort,
strictPort: false,
host: '127.0.0.1',
logger: config.logger
})

expect(port).not.toEqual(originalPort)

server.close()
testServer.close()
})

test('[strictPort=true, host=127.0.0.1] should use another port when already start a server on localhost.', async () => {
const originalPort = 5000
const server = createServer()
server.listen(originalPort, 'localhost')

const config = await resolveConfig({}, 'serve', 'production')
const testServer = createServer()
await expect(
httpServerStart(testServer, {
port: originalPort,
strictPort: true,
host: '127.0.0.1',
logger: config.logger
})
).rejects.toEqual(new Error(`Port ${originalPort} is already in use`))

server.close()
testServer.close()
})
})
12 changes: 12 additions & 0 deletions packages/playground/preview/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Preview</title>
</head>
<body>
<h1>Preview</h1>
<div><!--app-html--></div>
</body>
</html>
9 changes: 9 additions & 0 deletions packages/playground/preview/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "preview",
"version": "0.0.0",
"scripts": {
"dev": "vite --force",
"build": "vite build",
"preview": "vite preview"
}
}
72 changes: 58 additions & 14 deletions packages/vite/src/node/http.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,39 @@ async function getCertificate(cacheDir?: string) {
}
}

function checkPortOccupied(
port: number,
host?: string
): Promise<{ port: number; occupied: boolean }> {
return new Promise((resolve, reject) => {
const tempServer = require('http').createServer()

const onError = (e: Error & { code?: string }) => {
if (e.code === 'EADDRINUSE') {
checkPortOccupied(++port, host)
.then((r) => {
resolve({
port: r.port,
occupied: true
})
})
.catch(reject)
} else {
reject(e)
}
tempServer.removeListener('error', onError)
tempServer.close()
}

tempServer.on('error', onError)

tempServer.listen(port, host, () => {
tempServer.removeListener('error', onError)
tempServer.close(() => resolve({ port, occupied: false }))
})
})
}

export async function httpServerStart(
httpServer: HttpServer,
serverOptions: {
Expand All @@ -192,28 +225,39 @@ export async function httpServerStart(
logger: Logger
}
): Promise<number> {
const { strictPort, host, logger } = serverOptions
// Check the port usage of serverOptions.host
let checkInfo = await checkPortOccupied(serverOptions.port, host)

if (host === '127.0.0.1') {
// Check the port usage of localhost
checkInfo = await checkPortOccupied(serverOptions.port, 'localhost')
}

return new Promise((resolve, reject) => {
let { port, strictPort, host, logger } = serverOptions
const { port, occupied } = checkInfo

const onError = (e: Error & { code?: string }) => {
if (e.code === 'EADDRINUSE') {
if (strictPort) {
httpServer.removeListener('error', onError)
reject(new Error(`Port ${port} is already in use`))
} else {
logger.info(`Port ${port} is in use, trying another one...`)
httpServer.listen(++port, host)
}
} else {
httpServer.removeListener('error', onError)
reject(e)
}
if (occupied && strictPort) {
reject(new Error(`Port ${serverOptions.port} is already in use`))
return
}

const onError = (e: Error) => {
httpServer.removeListener('error', onError)
reject(e)
}

httpServer.on('error', onError)

httpServer.listen(port, host, () => {
httpServer.removeListener('error', onError)

if (occupied) {
logger.info(
`Port ${serverOptions.port} is in use, trying another one...`
)
}

resolve(port)
})
})
Expand Down