unplugin-https-reverse-proxy 1.0.0-beta.9 → 2.0.0

package/src/caddy/index.ts

@@ -1,17 +1,19 @@
+import { spawn } from 'node:child_process'
+import { chmodSync, createWriteStream, existsSync, mkdirSync, unlinkSync, writeFileSync } from 'node:fs'
+import { readFile, unlink, writeFile } from 'node:fs/promises'
 import { platform } from 'node:os'
+import { join } from 'node:path'
 import process from 'node:process'
-import { chmodSync, createWriteStream, existsSync, mkdirSync, unlinkSync } from 'node:fs'
-import { spawn } from 'node:child_process'
 import { got } from 'got-cjs'
 import { HttpProxyAgent } from 'http-proxy-agent'
 import { HttpsProxyAgent } from 'https-proxy-agent'
-import kill from 'kill-port'
-import { chmodRecursive, consola, once } from '../utils'
+import * as lockfile from 'proper-lockfile'
 import { addHost, removeHost } from '../host'
-import { TEMP_DIR, caddyPath, supportList } from './constants'
-import { logProgress, logProgressOver, tryPort } from './utils'
+import { chmodRecursive, consola, once } from '../utils'
+import { caddyFilePath, caddyLockFilePath, caddyPath, supportList, TEMP_DIR } from './constants'
+import { kill, logProgress, logProgressOver, tryPort } from './utils'
 
-export async function download() {
+export async function download(): Promise<string> {
   if (await testCaddy())
     return caddyPath
 
@@ -37,7 +39,7 @@ export async function download() {
     if (!support)
       return reject(new Error('not support'))
 
-    const dowmloadLink = `https://caddyserver.com/api/download?os=${support.platform}&arch=${support.arch}`
+    const dowmloadLink = `https://caddyserver.com/api/download?os=${support.platform}&arch=${support.arch}&p=github.com%2Fcaddyserver%2Fforwardproxy`
 
     existsSync(caddyPath) && unlinkSync(caddyPath)
 
@@ -74,7 +76,7 @@ export async function download() {
   })
 }
 
-function testCaddy() {
+function testCaddy(): Promise<boolean> {
   return new Promise((resolve, reject) => {
     if (!existsSync(caddyPath))
       return resolve(false)
@@ -103,13 +105,82 @@ export class CaddyInstant {
   private inited = false
   private stoped = false
 
+  /** has locked */
+  private locked = false
+  private caddyfile: string | undefined
+
+  private _caddyChild: ReturnType<typeof spawn> | undefined
+
+  private _source: string | undefined
+  private _target: string | undefined
+
   constructor() {
-    testCaddy().then(() => {
+    testCaddy().then(async () => {
+      await this.getCaddyfile()
+
       this.inited = true
     })
+
+    this.locked = this.checkLock()
+  }
+
+  checkLock(): boolean {
+    if (!existsSync(caddyLockFilePath))
+      writeFileSync(caddyLockFilePath, '')
+    return lockfile.checkSync(caddyLockFilePath)
+  }
+
+  async getCaddyfile(): Promise<string> {
+    if (!existsSync(caddyFilePath))
+      await this.initCaddyfile()
+
+    this.caddyfile = await readFile(caddyFilePath, 'utf-8')
+    return this.caddyfile
+  }
+
+  async initCaddyfile(): Promise<void> {
+    const contet = `
+{
+  debug
+  auto_https disable_redirects
+}
+
+:7601 {
+  root * "${join(
+    process.platform === 'win32'
+      ? `${process.env.AppData!}/Caddy`
+      : `${process.env.HOME!}/Library/Application Support/Caddy`,
+    './pki/authorities/local',
+  )}"
+  file_server browse
+}
+
+# 正向代理配置
+:7600 {
+  bind 0.0.0.0
+  
+  forward_proxy {
+    hide_ip
+    hide_via
+    acl {
+      allow all
+    }
+  }
+}
+`
+    await writeFile(caddyFilePath, contet)
+    this.caddyfile = contet
+  }
+
+  async writeCaddyfile(): Promise<void> {
+    return await writeFile(caddyFilePath, this.caddyfile || '')
+  }
+
+  async deleteCaddyfile(): Promise<void> {
+    return await unlink(caddyFilePath)
   }
 
-  async init() {
+  async init(): Promise<void> {
     await download()
     this.inited = true
   }
@@ -117,9 +188,8 @@ export class CaddyInstant {
   /**
    * @param source like `127.0.0.1:8080`
    * @param target like `test.abc.com`. And if you provide a port ,it will be ignore.
-   * @returns
    */
-  async run(source: string, target: string, options?: Partial<RunOptions>) {
+  async run(source: string, target: string, options?: Partial<RunOptions>): Promise<void> {
     source = source.replace('0.0.0.0', '127.0.0.1')
     const {
       restore = true,
@@ -128,111 +198,193 @@ export class CaddyInstant {
       https = false,
     } = options || {}
 
+    this._source = source
+    this._target = target
+
     if (!this.inited)
       await this.init()
 
-    if (https && await tryPort(443))
-      await kill(443, 'tcp')
-    if ((process.platform === 'win32' || !https) && await tryPort(80))
-      await kill(80, 'tcp')
-
     if (!await addHost(source.split(':')[0], target.split(':')[0]))
       throw new Error('update host failed')
     consola.success('update host success\n')
 
-    return new Promise<void>((resolve, reject) => {
-      // caddy reverse-proxy --from target --to source --internal-certs
-      const child = process.platform !== 'win32'
-        ? spawn('sudo', ['-E', caddyPath, 'reverse-proxy', '--from', `${target.split(':')[0]}${https ? '' : ':80'}`, '--to', `${source}`, '--internal-certs', '--insecure', '--disable-redirects'])
-        : spawn(caddyPath, ['reverse-proxy', '--from', `${target.split(':')[0]}`, '--to', `${source}`, '--internal-certs'])
+    await this.getCaddyfile()
+    if (!(this.caddyfile || '').includes(`${target.split(':')[0]}${https ? '' : ':80'}`)) {
+      this.caddyfile = `${this.caddyfile}
+${target.split(':')[0]}${https ? '' : ':80'} {
+  ${https ? 'tls internal' : ''}
+  reverse_proxy http://${source} {
+    health_uri ${base}
+    health_interval 2s
+    health_timeout 5s
+    fail_duration 2s
+    unhealthy_status 502 503 504 404
+    lb_try_duration 3s
+    lb_try_interval 300ms
+    health_headers {
+      Accept text/html
+      Accept-Encoding gzip, deflate, br
+      User-Agent Caddy-Health-Check
+    }
+
+    @error status 502 503 504 404
+    handle_response @error {
+      respond * 503 {
+        body "Service Unavailable"
+        close
+      }
+    }
+  }
+}
+`
 
-      child.on('error', (err) => {
-        return reject(err)
-      })
+      await this.writeCaddyfile()
+    }
+    if (!existsSync(caddyLockFilePath))
+      writeFileSync(caddyLockFilePath, '')
+
+    if (!this.locked) {
+      if (await tryPort(443))
+        await kill(443)
+      if ((process.platform === 'win32' || !https) && await tryPort(80))
+        await kill(80)
+    }
 
-      process.on('SIGINT', async () => {
-        if (!restore || this.stoped)
-          return
+    return new Promise<void>((resolve, reject) => {
+      const setupCleanup = (): void => {
+        process.on('SIGINT', async () => {
+          if (this.stoped)
+            return
 
-        try {
-          if (await removeHost(source.split(':')[0], target.split(':')[0]))
-            consola.success('restore host success\n')
+          process.stdin.resume()
 
-          else
-            consola.fail('restore host failed\n')
-        }
-        catch (e) {
-          consola.error(e)
-          consola.fail('restore host failed\n')
-        }
-        finally {
-          this.stoped = true
-          process.nextTick(() => {
-            process.exit()
-          })
-        }
-      })
-
-      const originalExit = process.exit.bind(process)
-
-      // @ts-expect-error override
-      process.exit = async (code?: number) => {
-        const port = Number(source.split(':')[1])
-        if (!Number.isNaN(port) && await tryPort(port))
-          await kill(port, 'tcp')
-
-        // fix `Error: EPERM: operation not permitted`
-        const pwd = process.cwd()
-        const viteCacheDir = `${pwd}/node_modules/.vite`
-        if (existsSync(viteCacheDir))
-          chmodRecursive(viteCacheDir, 0o777)
-        const nuxtCacheDir = `${pwd}/.nuxt`
-        if (existsSync(nuxtCacheDir))
-          await chmodRecursive(nuxtCacheDir, 0o777)
-        const webpackCacheDir = `${pwd}/node_modules/.cache`
-        if (existsSync(webpackCacheDir))
-          chmodRecursive(webpackCacheDir, 0o777)
-
-        if (!restore || this.stoped)
-          return originalExit(code)
-
-        try {
-          if (await removeHost(source.split(':')[0], target.split(':')[0]))
-            consola.success('restore host success\n')
-
-          else
-            consola.fail('restore host failed\n')
-        }
-        catch (e) {
-          consola.error(e)
-          consola.fail('restore host failed\n')
-        }
-        finally {
-          this.stoped = true
-          process.nextTick(() => {
-            originalExit(code)
-          })
+          try {
+            await this.baseCleanup(restore)
+          }
+          finally {
+            this.stoped = true
+            process.nextTick(() => {
+              process.exit()
+            })
+          }
+        })
+
+        const originalExit = process.exit.bind(process)
+
+        // @ts-expect-error override
+        process.exit = async (code?: number) => {
+          const port = Number(source.split(':')[1])
+          if (!Number.isNaN(port) && await tryPort(port))
+            await kill(port)
+
+          // fix `Error: EPERM: operation not permitted`
+          const pwd = process.cwd()
+          const viteCacheDir = `${pwd}/node_modules/.vite`
+          if (existsSync(viteCacheDir))
+            await chmodRecursive(viteCacheDir, 0o777).catch(() => { })
+          const nuxtCacheDir = `${pwd}/.nuxt`
+          if (existsSync(nuxtCacheDir))
+            await chmodRecursive(nuxtCacheDir, 0o777).catch(() => { })
+          const webpackCacheDir = `${pwd}/node_modules/.cache`
+          if (existsSync(webpackCacheDir))
+            await chmodRecursive(webpackCacheDir, 0o777).catch(() => { })
+
+          if (this.stoped)
+            return originalExit(code)
+
+          process.stdin.resume()
+
+          try {
+            await this.baseCleanup()
+          }
+
+          finally {
+            this.stoped = true
+            process.nextTick(() => {
+              originalExit(code)
+            })
+          }
         }
       }
 
-      child.stderr.on('data', (data) => {
-        const lines = (data.toString() as string).split('\n').map(line => line.trim())
-        for (const line of lines) {
-          // caddy log
-          // eslint-disable-next-line no-console
-          showCaddyLog && line && console.info(line)
-          if (line.includes('Error:') || (line && JSON.parse(line).level === 'error')) {
-            consola.error(line)
-            // child.kill()
-            return reject(line)
+      if (!this.locked) {
+        this._caddyChild = process.platform !== 'win32'
+          ? spawn('sudo', ['-E', caddyPath, 'run', '--config', caddyFilePath, '--watch'])
+          : spawn(caddyPath, ['run', '--config', caddyFilePath, '--watch'])
+
+        lockfile.lockSync(caddyLockFilePath)
+
+        this._caddyChild!.on('error', (err) => {
+          return reject(err)
+        })
+
+        this._caddyChild!.stderr?.on('data', async (data) => {
+          const lines = (data.toString() as string).split('\n').map(line => line.trim())
+          for (const line of lines) {
+            // caddy log
+            // eslint-disable-next-line no-console
+            showCaddyLog && line && console.info(line)
+            if (line.includes('Error:') || (line && JSON.parse(line).level === 'error')) {
+              if (line.includes('parsing caddyfile tokens')) {
+                consola.error('Caddyfile syntax error, please contact the author:\n', `${this.caddyfile}\n\n${line}\n`)
+                await this.baseCleanup()
+                process.exit()
+              }
+              else {
+                consola.error(`${line}\n`)
+                // child.kill()
+                return reject(line)
+              }
+            }
+            if (line.includes('config file changed'))
+              consola.success('Detect added a new reverse proxy config, restarted.\n')
+
+            if (line.includes('caddy proxying') || line.includes('serving initial'))
+              return resolve()
           }
-        }
-      })
+        })
+
+        this._caddyChild!.stdout?.on('data', (_data) => {
+          consola.info(_data.toString())
+          resolve()
+        })
+
+        setupCleanup()
+      }
+      else {
+        consola.info('Caddy is running in another process.')
+
+        setupCleanup()
 
-      child.stdout.on('data', (_data) => {
-        consola.info(_data.toString())
-        resolve()
-      })
+        return resolve()
+      }
     })
   }
+
+  async baseCleanup(restore: boolean = true): Promise<void> {
+    try {
+      if (restore && this._source && this._target) {
+        if (await removeHost(this._source.split(':')[0], this._target.split(':')[0]))
+          consola.success('Restore host success.\n')
+
+        else
+          consola.fail('Restore host failed.\n')
+      }
+    }
+    catch (e) {
+      consola.error(e)
+      consola.fail('Restore host failed.\n')
+    }
+    if (!this.locked && !this.stoped) {
+      this._caddyChild?.kill()
+      try {
+        await lockfile.unlock(caddyLockFilePath).catch(() => { })
+        await unlink(caddyFilePath).catch(() => { })
+        await unlink(caddyLockFilePath).catch(() => { })
+      }
+      catch (e) {
+        consola.error(e)
+      }
+    }
+  }
 }

package/src/caddy/utils.ts

@@ -1,3 +1,4 @@
+import { exec } from 'node:child_process'
 import { createServer } from 'node:net'
 import ora from 'ora'
 import { consola } from '../utils'
@@ -7,8 +8,8 @@ let spinner: ora.Ora
 /**
  * @returns whether the port is in use
  */
-export function tryPort(port: number) {
-  return new Promise<boolean>((resolve, reject) => {
+export function tryPort(port: number): Promise<boolean> {
+  return new Promise<boolean>((resolve, _reject) => {
     try {
       const server = createServer().listen(port)
       server.on('listening', () => {
@@ -22,13 +23,30 @@ export function tryPort(port: number) {
         server.close()
       })
     }
-    catch (e) {
+    catch {
       resolve(true)
     }
   })
 }
 
-function getNumber(number: number) {
+/**
+ * npx free-port :port
+ */
+export async function kill(port: number): Promise<void> {
+  return new Promise<void>((resolve, reject) => {
+    exec(`npx @maxbo/free-port ${port} -s`, (err, stdout, _stderr) => {
+      if (err) {
+        reject(err)
+      }
+      else {
+        consola.log(stdout)
+        resolve()
+      }
+    })
+  })
+}
+
+function getNumber(number: number): string {
   if (number <= 0)
     return '0%'
   else if (number < 100)
@@ -37,7 +55,7 @@ function getNumber(number: number) {
     return '100%'
 }
 
-export function logProgress(percent: number | string) {
+export function logProgress(percent: number | string): void {
   if (!spinner) {
     // empty a line before start
     consola.log('')
@@ -50,7 +68,7 @@ export function logProgress(percent: number | string) {
   else { spinner.text = `Download Caddy: ${getNumber(Number(percent) * 100)}` }
 }
 
-export function logProgressOver() {
+export function logProgressOver(): void {
   if (!spinner) {
     spinner = ora({
       text: 'Start Download Caddy: 100%',

package/src/host/index.ts

@@ -1,57 +1,52 @@
-import process from 'node:process'
 import { exec } from 'node:child_process'
 import { chmodSync } from 'node:fs'
+import process from 'node:process'
+import { promisify } from 'node:util'
 
-// @ts-expect-error no type
-import _Hosts from 'hosts-so-easy'
+import hostile from 'hostile'
 import { consola } from '../utils'
 
-const Hosts = _Hosts.default || _Hosts
-
-const hostInstance = new Hosts({
-  debounceTime: 50,
-  hostsFile: getPathOfSystemHostsPath(),
-})
+const _setHost = promisify(hostile.set)
+const _removeHost = promisify(hostile.remove)
 
-function getPathOfSystemHostsPath() {
+function getPathOfSystemHostsPath(): string {
   return process.platform === 'win32'
     ? `${process.env.windir || 'C:\\WINDOWS'}\\system32\\drivers\\etc\\hosts`
     : '/etc/hosts'
 }
 
-async function syncHost() {
-  return new Promise<boolean>((resolve, reject) => {
+async function syncHost(): Promise<boolean> {
+  return new Promise<boolean>((resolve, _reject) => {
     exec(
       process.platform === 'win32'
         ? 'ipconfig /flushdns'
         : 'sudo -E killall -HUP mDNSResponder',
-      (error, stdout, stderr) => {
+      (error, _stdout, _stderr) => {
         if (error) {
           consola.error(`exec error: ${error}`)
           return resolve(false)
         }
         return resolve(true)
-      })
+      },
+    )
   })
 }
 
-export async function addHost(ip: string, host: string) {
+export async function addHost(ip: string, host: string): Promise<boolean> {
   if (process.platform !== 'win32')
     chmodSync(getPathOfSystemHostsPath(), 0o777)
-  hostInstance.add('127.0.0.1', 'localhost')
-  hostInstance.add(ip, host)
+  await _setHost('127.0.0.1', 'localhost')
+  await _setHost(ip, host)
   if (ip === 'localhost')
-    hostInstance.add('127.0.0.1', host)
-  await hostInstance.updateFinish()
+    await _setHost('127.0.0.1', host)
   return await syncHost()
 }
 
-export async function removeHost(ip: string, host: string) {
+export async function removeHost(ip: string, host: string): Promise<boolean> {
   if (process.platform !== 'win32')
     chmodSync(getPathOfSystemHostsPath(), 0o777)
-  hostInstance.remove(ip, host)
+  await _removeHost(ip, host)
   if (ip === 'localhost')
-    hostInstance.remove('127.0.0.1', host)
-  await hostInstance.updateFinish()
+    await _removeHost('127.0.0.1', host)
   return await syncHost()
 }