chore: some cleanup

Author: chrisbbreuer

README.md

@@ -48,13 +48,15 @@ export interface ReverseProxyConfig {
   from: string // domain to proxy from, defaults to localhost:3000
   to: string // domain to proxy to, defaults to stacks.localhost
   https: boolean | TlsConfig // automatically uses https, defaults to true, also redirects http to https
+  etcHostsCleanup?: boolean // automatically cleans up /etc/hosts, defaults to false
   verbose: boolean // log verbose output, defaults to false
 }
 
 const config: ReverseProxyOptions = {
   from: 'localhost:3000',
   to: 'my-project.localhost',
   https: true,
+  etcHostsCleanup: true,
 }
 
 startProxy(config)

bin/cli.ts

@@ -1,92 +1,52 @@
-import type { ReverseProxyOption } from '../src/types'
-import os from 'node:os'
-import { CAC, log } from '@stacksjs/cli'
-import { readFileSync, writeFileSync } from '@stacksjs/storage'
+import { CAC } from '@stacksjs/cli'
 import { version } from '../package.json'
 import { config } from '../src/config'
+import { httpsConfig } from '../src/https'
 import { startProxy } from '../src/start'
+import { caCertPath, certPath, keyPath } from '../src/utils'
 
 const cli = new CAC('reverse-proxy')
 
+interface ReverseProxyOption {
+  from: string
+  to: string
+  keyPath: string
+  certPath: string
+  caCertPath: string
+  etcHostsCleanup: boolean
+  verbose: boolean
+}
+
 cli
   .command('start', 'Start the Reverse Proxy Server')
   .option('--from <from>', 'The URL to proxy from', { default: config.from })
   .option('--to <to>', 'The URL to proxy to', { default: config.to })
-  .option('--key-path <path>', 'Absolute path to the SSL key', { default: config.keyPath })
-  .option('--cert-path <path>', 'Absolute path to the SSL certificate', { default: config.certPath })
+  .option('--key-path <path>', 'Absolute path to the SSL key', { default: keyPath() })
+  .option('--cert-path <path>', 'Absolute path to the SSL certificate', { default: certPath() })
+  .option('--ca-cert-path <path>', 'Absolute path to the SSL CA certificate', { default: caCertPath() })
+  .option('--etc-hosts-cleanup', 'Cleanup /etc/hosts on exit', { default: config.etcHostsCleanup })
   .option('--verbose', 'Enable verbose logging', { default: config.verbose })
   .example('reverse-proxy start --from localhost:5173 --to my-project.localhost')
   .example('reverse-proxy start --from localhost:3000 --to my-project.localhost/api')
   .example('reverse-proxy start --from localhost:3000 --to localhost:3001')
   .example('reverse-proxy start --from localhost:5173 --to my-project.test --key-path /absolute/path/to/key --cert-path /absolute/path/to/cert')
   .action(async (options?: ReverseProxyOption) => {
+    const https = {
+      ...httpsConfig(),
+      keyPath: options?.keyPath || keyPath(),
+      certPath: options?.certPath || certPath(),
+      caCertPath: options?.caCertPath || caCertPath(),
+    }
+
     startProxy({
       from: options?.from,
       to: options?.to,
-      keyPath: options?.keyPath,
-      certPath: options?.certPath,
+      https,
+      etcHostsCleanup: options?.etcHostsCleanup,
       verbose: options?.verbose,
     })
   })
 
-cli
-  .command(
-    'update:etc-hosts',
-    'Update the /etc/hosts file with the proxy domains. Please note, this command requires sudo/admin permissions.',
-  )
-  .alias('update-etc-hosts')
-  .example('sudo reverse-proxy update:etc-hosts')
-  .example('sudo reverse-proxy update-etc-hosts')
-  .action(async () => {
-    log.info('Ensuring /etc/hosts file covers the proxy domain/s...')
-
-    const hostsFilePath = os.platform() === 'win32' ? 'C:\\Windows\\System32\\drivers\\etc\\hosts' : '/etc/hosts'
-
-    if (config && typeof config === 'object') {
-      const entriesToAdd = Object.entries(config).map(
-        ([from, to]) => `127.0.0.1 ${to} # reverse-proxy mapping for ${from}`,
-      )
-      // Ensure "127.0.0.1 localhost" is in the array
-      entriesToAdd.push('127.0.0.1 localhost # essential localhost mapping')
-
-      try {
-        let currentHostsContent = readFileSync(hostsFilePath, 'utf8')
-        let updated = false
-
-        for (const entry of entriesToAdd) {
-          const [ip, host] = entry.split(' ', 2)
-          // Use a regex to match the line with any amount of whitespace between IP and host
-          const regex = new RegExp(`^${ip}\\s+${host.split(' ')[0]}(\\s|$)`, 'm')
-          // Check if the entry (domain) is already in the file
-          if (!regex.test(currentHostsContent)) {
-            // If not, append it
-            currentHostsContent += `\n${entry}`
-            updated = true
-          }
-          else {
-            log.info(`Entry for ${host} already exists in the hosts file.`)
-          }
-        }
-
-        if (updated) {
-          writeFileSync(hostsFilePath, currentHostsContent, 'utf8')
-          log.success('Hosts file updated with latest proxy domains.')
-        }
-        else {
-          log.info('No new entries were added to the hosts file.')
-        }
-      }
-      catch (error: unknown) {
-        if ((error as NodeJS.ErrnoException).code === 'EACCES')
-          console.error('Permission denied. Please run this command with administrative privileges.')
-        else console.error(`An error occurred: ${(error as NodeJS.ErrnoException).message}`)
-      }
-    }
-    else {
-      console.log('No proxies found. Is your config configured properly?')
-    }
-  })
-
 cli.command('version', 'Show the version of the Reverse Proxy CLI').action(() => {
   console.log(version)
 })

src/index.ts

@@ -3,3 +3,4 @@ export * from './hosts'
 export * from './https'
 export * from './start'
 export * from './types'
+export * from './utils'

src/types.ts

@@ -15,7 +15,6 @@ export interface SSLConfig {
   key: string
   cert: string
   ca?: string | string[]
-  secureOptions?: number
 }
 
 export interface ProxySetupOptions extends Omit<ReverseProxyOption, 'from'> {

src/utils.ts

@@ -1,5 +1,28 @@
+import { homedir } from 'node:os'
+import { join } from 'node:path'
 import { config } from './config'
 
+export function keyPath(): string {
+  if (typeof config.https === 'boolean')
+    return join(homedir(), '.stacks', 'ssl', `stacks.localhost.key`)
+
+  return config.https.keyPath
+}
+
+export function certPath(): string {
+  if (typeof config.https === 'boolean')
+    return join(homedir(), '.stacks', 'ssl', `stacks.localhost.crt`)
+
+  return config.https.certPath
+}
+
+export function caCertPath(): string {
+  if (typeof config.https === 'boolean')
+    return join(homedir(), '.stacks', 'ssl', `stacks.localhost.ca.crt`)
+
+  return config.https.caCertPath
+}
+
 export function debugLog(category: string, message: string, verbose?: boolean): void {
   if (verbose || config.verbose) {
     // eslint-disable-next-line no-console