@adonisjs/assembler 6.1.3-5 → 6.1.3-7

package/src/dev_server.ts

@@ -1,306 +0,0 @@
-/*
- * @adonisjs/assembler
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import picomatch from 'picomatch'
-import type tsStatic from 'typescript'
-import { type ExecaChildProcess } from 'execa'
-import { cliui, type Logger } from '@poppinss/cliui'
-import type { Watcher } from '@poppinss/chokidar-ts'
-
-import type { DevServerOptions } from './types.js'
-import { AssetsDevServer } from './assets_dev_server.js'
-import { getPort, isDotEnvFile, isRcFile, runNode, watch } from './helpers.js'
-
-/**
- * Instance of CLIUI
- */
-const ui = cliui()
-
-/**
- * Exposes the API to start the development. Optionally, the watch API can be
- * used to watch for file changes and restart the development server.
- *
- * The Dev server performs the following actions
- *
- * - Assigns a random PORT, when PORT inside .env file is in use
- * - Uses tsconfig.json file to collect a list of files to watch.
- * - Uses metaFiles from .adonisrc.json file to collect a list of files to watch.
- * - Restart HTTP server on every file change.
- */
-export class DevServer {
-  #cwd: URL
-  #logger = ui.logger
-  #options: DevServerOptions
-  #isWatching: boolean = false
-  #scriptFile: string = 'bin/server.js'
-  #isMetaFileWithReloadsEnabled: picomatch.Matcher
-  #isMetaFileWithReloadsDisabled: picomatch.Matcher
-
-  #onError?: (error: any) => any
-  #onClose?: (exitCode: number) => any
-
-  #httpServer?: ExecaChildProcess<string>
-  #watcher?: ReturnType<Watcher['watch']>
-  #assetsServer?: AssetsDevServer
-
-  /**
-   * Getting reference to colors library from logger
-   */
-  get #colors() {
-    return this.#logger.getColors()
-  }
-
-  constructor(cwd: URL, options: DevServerOptions) {
-    this.#cwd = cwd
-    this.#options = options
-
-    this.#isMetaFileWithReloadsEnabled = picomatch(
-      (this.#options.metaFiles || [])
-        .filter(({ reloadServer }) => reloadServer === true)
-        .map(({ pattern }) => pattern)
-    )
-
-    this.#isMetaFileWithReloadsDisabled = picomatch(
-      (this.#options.metaFiles || [])
-        .filter(({ reloadServer }) => reloadServer !== true)
-        .map(({ pattern }) => pattern)
-    )
-  }
-
-  /**
-   * Inspect if child process message is from AdonisJS HTTP server
-   */
-  #isAdonisJSReadyMessage(
-    message: unknown
-  ): message is { isAdonisJS: true; environment: 'web'; port: number; host: string } {
-    return (
-      message !== null &&
-      typeof message === 'object' &&
-      'isAdonisJS' in message &&
-      'environment' in message &&
-      message.environment === 'web'
-    )
-  }
-
-  /**
-   * Conditionally clear the terminal screen
-   */
-  #clearScreen() {
-    if (this.#options.clearScreen) {
-      process.stdout.write('\u001Bc')
-    }
-  }
-
-  /**
-   * Starts the HTTP server
-   */
-  #startHTTPServer(port: string, mode: 'blocking' | 'nonblocking') {
-    this.#httpServer = runNode(this.#cwd, {
-      script: this.#scriptFile,
-      env: { PORT: port, ...this.#options.env },
-      nodeArgs: this.#options.nodeArgs,
-      scriptArgs: this.#options.scriptArgs,
-    })
-
-    this.#httpServer.on('message', (message) => {
-      if (this.#isAdonisJSReadyMessage(message)) {
-        ui.sticker()
-          .useColors(this.#colors)
-          .useRenderer(this.#logger.getRenderer())
-          .add(`Server address: ${this.#colors.cyan(`http://${message.host}:${message.port}`)}`)
-          .add(
-            `File system watcher: ${this.#colors.cyan(
-              `${this.#isWatching ? 'enabled' : 'disabled'}`
-            )}`
-          )
-          .render()
-      }
-    })
-
-    this.#httpServer
-      .then((result) => {
-        this.#logger.warning(`underlying HTTP server closed with status code "${result.exitCode}"`)
-        if (mode === 'nonblocking') {
-          this.#onClose?.(result.exitCode)
-          this.#watcher?.close()
-          this.#assetsServer?.stop()
-        }
-      })
-      .catch((error) => {
-        this.#logger.warning('unable to connect to underlying HTTP server process')
-        this.#logger.fatal(error)
-        this.#onError?.(error)
-        this.#watcher?.close()
-        this.#assetsServer?.stop()
-      })
-  }
-
-  /**
-   * Starts the assets server
-   */
-  #startAssetsServer() {
-    this.#assetsServer = new AssetsDevServer(this.#cwd, this.#options.assets)
-    this.#assetsServer.start()
-  }
-
-  /**
-   * Restarts the HTTP server
-   */
-  #restartHTTPServer(port: string) {
-    if (this.#httpServer) {
-      this.#httpServer.removeAllListeners()
-      this.#httpServer.kill('SIGKILL')
-    }
-
-    this.#startHTTPServer(port, 'blocking')
-  }
-
-  /**
-   * Handles a non TypeScript file change
-   */
-  #handleFileChange(action: string, port: string, relativePath: string) {
-    if (isDotEnvFile(relativePath) || isRcFile(relativePath)) {
-      this.#clearScreen()
-      this.#logger.log(`${this.#colors.green(action)} ${relativePath}`)
-      this.#restartHTTPServer(port)
-      return
-    }
-
-    if (this.#isMetaFileWithReloadsEnabled(relativePath)) {
-      this.#clearScreen()
-      this.#logger.log(`${this.#colors.green(action)} ${relativePath}`)
-      this.#restartHTTPServer(port)
-      return
-    }
-
-    if (this.#isMetaFileWithReloadsDisabled(relativePath)) {
-      this.#clearScreen()
-      this.#logger.log(`${this.#colors.green(action)} ${relativePath}`)
-    }
-  }
-
-  /**
-   * Handles TypeScript source file change
-   */
-  #handleSourceFileChange(action: string, port: string, relativePath: string) {
-    this.#clearScreen()
-    this.#logger.log(`${this.#colors.green(action)} ${relativePath}`)
-    this.#restartHTTPServer(port)
-  }
-
-  /**
-   * Set a custom CLI UI logger
-   */
-  setLogger(logger: Logger) {
-    this.#logger = logger
-    this.#assetsServer?.setLogger(logger)
-    return this
-  }
-
-  /**
-   * Add listener to get notified when dev server is
-   * closed
-   */
-  onClose(callback: (exitCode: number) => any): this {
-    this.#onClose = callback
-    return this
-  }
-
-  /**
-   * Add listener to get notified when dev server exists
-   * with an error
-   */
-  onError(callback: (error: any) => any): this {
-    this.#onError = callback
-    return this
-  }
-
-  /**
-   * Start the development server
-   */
-  async start() {
-    this.#clearScreen()
-    this.#logger.info('starting HTTP server...')
-    this.#startHTTPServer(String(await getPort(this.#cwd)), 'nonblocking')
-    this.#startAssetsServer()
-  }
-
-  /**
-   * Start the development server in watch mode
-   */
-  async startAndWatch(ts: typeof tsStatic, options?: { poll: boolean }) {
-    const port = String(await getPort(this.#cwd))
-    this.#isWatching = true
-
-    this.#clearScreen()
-
-    this.#logger.info('starting HTTP server...')
-    this.#startHTTPServer(port, 'blocking')
-
-    this.#startAssetsServer()
-
-    /**
-     * Create watcher using tsconfig.json file
-     */
-    const output = watch(this.#cwd, ts, options || {})
-    if (!output) {
-      this.#onClose?.(1)
-      return
-    }
-
-    /**
-     * Storing reference to watcher, so that we can close it
-     * when HTTP server exists with error
-     */
-    this.#watcher = output.chokidar
-
-    /**
-     * Notify the watcher is ready
-     */
-    output.watcher.on('watcher:ready', () => {
-      this.#logger.info('watching file system for changes...')
-    })
-
-    /**
-     * Cleanup when watcher dies
-     */
-    output.chokidar.on('error', (error) => {
-      this.#logger.warning('file system watcher failure')
-      this.#logger.fatal(error)
-      this.#onError?.(error)
-      output.chokidar.close()
-    })
-
-    /**
-     * Changes in TypeScript source file
-     */
-    output.watcher.on('source:add', ({ relativePath }) =>
-      this.#handleSourceFileChange('add', port, relativePath)
-    )
-    output.watcher.on('source:change', ({ relativePath }) =>
-      this.#handleSourceFileChange('update', port, relativePath)
-    )
-    output.watcher.on('source:unlink', ({ relativePath }) =>
-      this.#handleSourceFileChange('delete', port, relativePath)
-    )
-
-    /**
-     * Changes in non-TypeScript source files
-     */
-    output.watcher.on('add', ({ relativePath }) =>
-      this.#handleFileChange('add', port, relativePath)
-    )
-    output.watcher.on('change', ({ relativePath }) =>
-      this.#handleFileChange('update', port, relativePath)
-    )
-    output.watcher.on('unlink', ({ relativePath }) =>
-      this.#handleFileChange('delete', port, relativePath)
-    )
-  }
-}

package/src/helpers.ts

@@ -1,162 +0,0 @@
-/*
- * @adonisjs/assembler
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-
-import getRandomPort from 'get-port'
-import type tsStatic from 'typescript'
-import { fileURLToPath } from 'node:url'
-import { execaNode, execa } from 'execa'
-import { EnvLoader, EnvParser } from '@adonisjs/env'
-import { ConfigParser, Watcher } from '@poppinss/chokidar-ts'
-
-import type { RunOptions, WatchOptions } from './types.js'
-
-/**
- * Default set of args to pass in order to run TypeScript
- * source. Used by "run" and "runNode" scripts
- */
-const DEFAULT_NODE_ARGS = [
-  // Use ts-node/esm loader. The project must install it
-  '--loader=ts-node/esm',
-  // Disable annonying warnings
-  '--no-warnings',
-  // Enable expiremental meta resolve for cases where someone uses magic import string
-  '--experimental-import-meta-resolve',
-]
-
-/**
- * Parses tsconfig.json and prints errors using typescript compiler
- * host
- */
-export function parseConfig(cwd: string | URL, ts: typeof tsStatic) {
-  const { config, error } = new ConfigParser(cwd, 'tsconfig.json', ts).parse()
-  if (error) {
-    const compilerHost = ts.createCompilerHost({})
-    console.log(ts.formatDiagnosticsWithColorAndContext([error], compilerHost))
-    return
-  }
-
-  if (config!.errors.length) {
-    const compilerHost = ts.createCompilerHost({})
-    console.log(ts.formatDiagnosticsWithColorAndContext(config!.errors, compilerHost))
-    return
-  }
-
-  return config
-}
-
-/**
- * Runs a Node.js script as a child process and inherits the stdio streams
- */
-export function runNode(cwd: string | URL, options: RunOptions) {
-  const childProcess = execaNode(options.script, options.scriptArgs, {
-    nodeOptions: DEFAULT_NODE_ARGS.concat(options.nodeArgs),
-    preferLocal: true,
-    windowsHide: false,
-    localDir: cwd,
-    cwd,
-    buffer: false,
-    stdio: options.stdio || 'inherit',
-    env: {
-      ...(options.stdio === 'pipe' ? { FORCE_COLOR: 'true' } : {}),
-      ...options.env,
-    },
-  })
-
-  return childProcess
-}
-
-/**
- * Runs a script as a child process and inherits the stdio streams
- */
-export function run(cwd: string | URL, options: Omit<RunOptions, 'nodeArgs'>) {
-  const childProcess = execa(options.script, options.scriptArgs, {
-    preferLocal: true,
-    windowsHide: false,
-    localDir: cwd,
-    cwd,
-    buffer: false,
-    stdio: options.stdio || 'inherit',
-    env: {
-      ...(options.stdio === 'pipe' ? { FORCE_COLOR: 'true' } : {}),
-      ...options.env,
-    },
-  })
-
-  return childProcess
-}
-
-/**
- * Watches the file system using tsconfig file
- */
-export function watch(cwd: string | URL, ts: typeof tsStatic, options: WatchOptions) {
-  const config = parseConfig(cwd, ts)
-  if (!config) {
-    return
-  }
-
-  const watcher = new Watcher(typeof cwd === 'string' ? cwd : fileURLToPath(cwd), config!)
-  const chokidar = watcher.watch(['.'], { usePolling: options.poll })
-  return { watcher, chokidar }
-}
-
-/**
- * Check if file is an .env file
- */
-export function isDotEnvFile(filePath: string) {
-  if (filePath === '.env') {
-    return true
-  }
-
-  return filePath.includes('.env.')
-}
-
-/**
- * Check if file is .adonisrc.json file
- */
-export function isRcFile(filePath: string) {
-  return filePath === '.adonisrc.json'
-}
-
-/**
- * Returns the port to use after inspect the dot-env files inside
- * a given directory.
- *
- * A random port is used when the specified port is in use. Following
- * is the logic for finding a specified port.
- *
- * - The "process.env.PORT" value is used if exists.
- * - The dot-env files are loaded using the "EnvLoader" and the PORT
- *   value is by iterating over all the loaded files. The iteration
- *   stops after first find.
- */
-export async function getPort(cwd: URL): Promise<number> {
-  /**
-   * Use existing port if exists
-   */
-  if (process.env.PORT) {
-    return getRandomPort({ port: Number(process.env.PORT) })
-  }
-
-  /**
-   * Loop over files and use the port from their contents. Stops
-   * after first match
-   */
-  const files = await new EnvLoader(cwd).load()
-  for (let file of files) {
-    const envVariables = new EnvParser(file.contents).parse()
-    if (envVariables.PORT) {
-      return getRandomPort({ port: Number(envVariables.PORT) })
-    }
-  }
-
-  /**
-   * Use 3333 as the port
-   */
-  return getRandomPort({ port: 3333 })
-}