@adonisjs/assembler 6.1.3-2 → 6.1.3-21

package/build/src/dev_server.js

@@ -1,23 +1,46 @@
-import getPort from 'get-port';
+/*
+ * @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 { cliui } from '@poppinss/cliui';
-import { EnvLoader, EnvParser } from '@adonisjs/env';
-import { watch } from './watch.js';
-import { run, runNode } from './run.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;
     #logger = ui.logger;
     #options;
     #isWatching = false;
     #scriptFile = 'bin/server.js';
-    #httpServerProcess;
     #isMetaFileWithReloadsEnabled;
     #isMetaFileWithReloadsDisabled;
-    #watcher;
-    #assetsServerProcess;
     #onError;
     #onClose;
+    #httpServer;
+    #watcher;
+    #assetsServer;
+    /**
+     * Getting reference to colors library from logger
+     */
     get #colors() {
         return this.#logger.getColors();
     }
@@ -31,15 +54,9 @@ export class DevServer {
             .filter(({ reloadServer }) => reloadServer !== true)
             .map(({ pattern }) => pattern));
     }
-    #isDotEnvFile(filePath) {
-        if (filePath === '.env') {
-            return true;
-        }
-        return filePath.includes('.env.');
-    }
-    #isRcFile(filePath) {
-        return filePath === '.adonisrc.json';
-    }
+    /**
+     * Inspect if child process message is from AdonisJS HTTP server
+     */
     #isAdonisJSReadyMessage(message) {
         return (message !== null &&
             typeof message === 'object' &&
@@ -47,65 +64,25 @@ export class DevServer {
             'environment' in message &&
             message.environment === 'web');
     }
+    /**
+     * Conditionally clear the terminal screen
+     */
     #clearScreen() {
         if (this.#options.clearScreen) {
             process.stdout.write('\u001Bc');
         }
     }
-    #logViteDevServerMessage(data) {
-        const dataString = data.toString();
-        const lines = dataString.split('\n');
-        if (dataString.includes('ready in')) {
-            console.log('');
-            console.log(dataString.trim());
-            return;
-        }
-        if (dataString.includes('Local') && dataString.includes('Network')) {
-            const sticker = ui.sticker().useColors(this.#colors).useRenderer(this.#logger.getRenderer());
-            lines.forEach((line) => {
-                if (line.trim()) {
-                    sticker.add(line);
-                }
-            });
-            sticker.render();
-            return;
-        }
-        lines.forEach((line) => {
-            if (line.trim()) {
-                console.log(line);
-            }
-        });
-    }
-    #logAssetsDevServerMessage(data) {
-        const dataString = data.toString();
-        const lines = dataString.split('\n');
-        lines.forEach((line) => {
-            if (line.trim()) {
-                console.log(line);
-            }
-        });
-    }
-    async #getPort() {
-        if (process.env.PORT) {
-            return getPort({ port: Number(process.env.PORT) });
-        }
-        const files = await new EnvLoader(this.#cwd).load();
-        for (let file of files) {
-            const envVariables = new EnvParser(file.contents).parse();
-            if (envVariables.PORT) {
-                return getPort({ port: Number(envVariables.PORT) });
-            }
-        }
-        return getPort({ port: 3333 });
-    }
+    /**
+     * Starts the HTTP server
+     */
     #startHTTPServer(port, mode) {
-        this.#httpServerProcess = runNode(this.#cwd, {
+        this.#httpServer = runNode(this.#cwd, {
             script: this.#scriptFile,
             env: { PORT: port, ...this.#options.env },
             nodeArgs: this.#options.nodeArgs,
             scriptArgs: this.#options.scriptArgs,
         });
-        this.#httpServerProcess.on('message', (message) => {
+        this.#httpServer.on('message', (message) => {
             if (this.#isAdonisJSReadyMessage(message)) {
                 ui.sticker()
                     .useColors(this.#colors)
@@ -115,172 +92,162 @@ export class DevServer {
                     .render();
             }
         });
-        this.#httpServerProcess
+        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();
+            if (mode === 'nonblocking') {
+                this.#onError?.(error);
+                this.#watcher?.close();
+                this.#assetsServer?.stop();
+            }
         });
     }
+    /**
+     * Starts the assets server
+     */
     #startAssetsServer() {
-        const assetsBundler = this.#options.assets;
-        if (!assetsBundler?.serve) {
-            return;
+        this.#assetsServer = new AssetsDevServer(this.#cwd, this.#options.assets);
+        this.#assetsServer.setLogger(this.#logger);
+        this.#assetsServer.start();
+    }
+    /**
+     * Restarts the HTTP server
+     */
+    #restartHTTPServer(port) {
+        if (this.#httpServer) {
+            this.#httpServer.removeAllListeners();
+            this.#httpServer.kill('SIGKILL');
         }
-        this.#logger.info(`starting "${assetsBundler.driver}" dev server...`);
-        this.#assetsServerProcess = run(this.#cwd, {
-            script: assetsBundler.cmd,
-            stdio: 'pipe',
-            scriptArgs: this.#options.scriptArgs,
-        });
-        this.#assetsServerProcess.stdout?.on('data', (data) => {
-            if (assetsBundler.driver === 'vite') {
-                this.#logViteDevServerMessage(data);
-            }
-            else {
-                this.#logAssetsDevServerMessage(data);
-            }
-        });
-        this.#assetsServerProcess.stderr?.on('data', (data) => {
-            if (assetsBundler.driver === 'vite') {
-                this.#logViteDevServerMessage(data);
-            }
-            else {
-                this.#logAssetsDevServerMessage(data);
-            }
-        });
-        this.#assetsServerProcess
-            .then((result) => {
-            this.#logger.warning(`"${assetsBundler.driver}" dev server closed with status code "${result.exitCode}"`);
-        })
-            .catch((error) => {
-            this.#logger.warning(`unable to connect to "${assetsBundler.driver}" dev server`);
-            this.#logger.fatal(error);
-        });
+        this.#startHTTPServer(port, 'blocking');
     }
-    #restart(port) {
-        if (this.#httpServerProcess) {
-            this.#httpServerProcess.removeAllListeners();
-            this.#httpServerProcess.kill('SIGKILL');
+    /**
+     * Handles a non TypeScript file change
+     */
+    #handleFileChange(action, port, relativePath) {
+        if (isDotEnvFile(relativePath) || isRcFile(relativePath)) {
+            this.#clearScreen();
+            this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
+            this.#restartHTTPServer(port);
+            return;
         }
-        this.#startHTTPServer(port, 'blocking');
+        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, port, relativePath) {
+        this.#clearScreen();
+        this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
+        this.#restartHTTPServer(port);
     }
+    /**
+     * Set a custom CLI UI logger
+     */
     setLogger(logger) {
         this.#logger = logger;
+        this.#assetsServer?.setLogger(logger);
         return this;
     }
+    /**
+     * Add listener to get notified when dev server is
+     * closed
+     */
     onClose(callback) {
         this.#onClose = callback;
         return this;
     }
+    /**
+     * Add listener to get notified when dev server exists
+     * with an error
+     */
     onError(callback) {
         this.#onError = callback;
         return this;
     }
+    /**
+     * Close watchers and running child processes
+     */
+    async close() {
+        await this.#watcher?.close();
+        this.#assetsServer?.stop();
+        if (this.#httpServer) {
+            this.#httpServer.removeAllListeners();
+            this.#httpServer.kill('SIGKILL');
+        }
+    }
+    /**
+     * Start the development server
+     */
     async start() {
         this.#clearScreen();
         this.#logger.info('starting HTTP server...');
-        this.#startHTTPServer(String(await this.#getPort()), 'nonblocking');
+        this.#startHTTPServer(String(await getPort(this.#cwd)), 'nonblocking');
         this.#startAssetsServer();
     }
+    /**
+     * Start the development server in watch mode
+     */
     async startAndWatch(ts, options) {
-        const port = String(await this.#getPort());
+        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();
         });
-        output.watcher.on('source:add', ({ relativePath }) => {
-            this.#clearScreen();
-            this.#logger.log(`${this.#colors.green('add')} ${relativePath}`);
-            this.#restart(port);
-        });
-        output.watcher.on('source:change', ({ relativePath }) => {
-            this.#clearScreen();
-            this.#logger.log(`${this.#colors.green('update')} ${relativePath}`);
-            this.#restart(port);
-        });
-        output.watcher.on('source:unlink', ({ relativePath }) => {
-            this.#clearScreen();
-            this.#logger.log(`${this.#colors.green('delete')} ${relativePath}`);
-            this.#restart(port);
-        });
-        output.watcher.on('add', ({ relativePath }) => {
-            if (this.#isDotEnvFile(relativePath) || this.#isRcFile(relativePath)) {
-                this.#clearScreen();
-                this.#logger.log(`${this.#colors.green('add')} ${relativePath}`);
-                this.#restart(port);
-                return;
-            }
-            if (this.#isMetaFileWithReloadsEnabled(relativePath)) {
-                this.#clearScreen();
-                this.#logger.log(`${this.#colors.green('add')} ${relativePath}`);
-                this.#restart(port);
-                return;
-            }
-            if (this.#isMetaFileWithReloadsDisabled(relativePath)) {
-                this.#clearScreen();
-                this.#logger.log(`${this.#colors.green('add')} ${relativePath}`);
-            }
-        });
-        output.watcher.on('change', ({ relativePath }) => {
-            if (this.#isDotEnvFile(relativePath) || this.#isRcFile(relativePath)) {
-                this.#clearScreen();
-                this.#logger.log(`${this.#colors.green('update')} ${relativePath}`);
-                this.#restart(port);
-                return;
-            }
-            if (this.#isMetaFileWithReloadsEnabled(relativePath)) {
-                this.#clearScreen();
-                this.#logger.log(`${this.#colors.green('update')} ${relativePath}`);
-                this.#restart(port);
-                return;
-            }
-            if (this.#isMetaFileWithReloadsDisabled(relativePath)) {
-                this.#clearScreen();
-                this.#logger.log(`${this.#colors.green('update')} ${relativePath}`);
-            }
-        });
-        output.watcher.on('unlink', ({ relativePath }) => {
-            if (this.#isDotEnvFile(relativePath) || this.#isRcFile(relativePath)) {
-                this.#clearScreen();
-                this.#logger.log(`${this.#colors.green('delete')} ${relativePath}`);
-                this.#restart(port);
-                return;
-            }
-            if (this.#isMetaFileWithReloadsEnabled(relativePath)) {
-                this.#clearScreen();
-                this.#logger.log(`${this.#colors.green('delete')} ${relativePath}`);
-                this.#restart(port);
-                return;
-            }
-            if (this.#isMetaFileWithReloadsDisabled(relativePath)) {
-                this.#clearScreen();
-                this.#logger.log(`${this.#colors.green('delete')} ${relativePath}`);
-            }
-        });
+        /**
+         * 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/build/src/helpers.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" resolution-mode="require"/>
+import type tsStatic from 'typescript';
+import { Watcher } from '@poppinss/chokidar-ts';
+import type { RunOptions, WatchOptions } from './types.js';
+/**
+ * Parses tsconfig.json and prints errors using typescript compiler
+ * host
+ */
+export declare function parseConfig(cwd: string | URL, ts: typeof tsStatic): tsStatic.ParsedCommandLine | undefined;
+/**
+ * Runs a Node.js script as a child process and inherits the stdio streams
+ */
+export declare function runNode(cwd: string | URL, options: RunOptions): import("execa").ExecaChildProcess<string>;
+/**
+ * Runs a script as a child process and inherits the stdio streams
+ */
+export declare function run(cwd: string | URL, options: Omit<RunOptions, 'nodeArgs'>): import("execa").ExecaChildProcess<string>;
+/**
+ * Watches the file system using tsconfig file
+ */
+export declare function watch(cwd: string | URL, ts: typeof tsStatic, options: WatchOptions): {
+    watcher: Watcher;
+    chokidar: import("chokidar").FSWatcher;
+} | undefined;
+/**
+ * Check if file is an .env file
+ */
+export declare function isDotEnvFile(filePath: string): boolean;
+/**
+ * Check if file is .adonisrc.json file
+ */
+export declare function isRcFile(filePath: string): boolean;
+/**
+ * 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 declare function getPort(cwd: URL): Promise<number>;
+/**
+ * Helper function to copy files from relative paths or glob
+ * patterns
+ */
+export declare function copyFiles(files: string[], cwd: string, outDir: string): Promise<string[]>;

package/build/src/helpers.js

@@ -0,0 +1,183 @@
+/*
+ * @adonisjs/assembler
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import cpy from 'cpy';
+import { isNotJunk } from 'junk';
+import fastGlob from 'fast-glob';
+import getRandomPort from 'get-port';
+import { fileURLToPath } from 'node:url';
+import { execaNode, execa } from 'execa';
+import { isAbsolute, relative } from 'node:path';
+import { EnvLoader, EnvParser } from '@adonisjs/env';
+import { ConfigParser, Watcher } from '@poppinss/chokidar-ts';
+import debug from './debug.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',
+    // Enable source maps, since TSNode source maps are broken
+    '--enable-source-maps',
+];
+/**
+ * Parses tsconfig.json and prints errors using typescript compiler
+ * host
+ */
+export function parseConfig(cwd, ts) {
+    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, options) {
+    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, options) {
+    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, ts, options) {
+    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) {
+    if (filePath === '.env') {
+        return true;
+    }
+    return filePath.includes('.env.');
+}
+/**
+ * Check if file is .adonisrc.json file
+ */
+export function isRcFile(filePath) {
+    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) {
+    /**
+     * 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 });
+}
+/**
+ * Helper function to copy files from relative paths or glob
+ * patterns
+ */
+export async function copyFiles(files, cwd, outDir) {
+    /**
+     * Looping over files and create a new collection with paths
+     * and glob patterns
+     */
+    const { paths, patterns } = files.reduce((result, file) => {
+        if (fastGlob.isDynamicPattern(file)) {
+            result.patterns.push(file);
+        }
+        else {
+            result.paths.push(file);
+        }
+        return result;
+    }, { patterns: [], paths: [] });
+    debug('copyFiles inputs: %O, paths: %O, patterns: %O', files, paths, patterns);
+    /**
+     * Getting list of relative paths from glob patterns
+     */
+    const filePaths = paths.concat(await fastGlob(patterns, { cwd }));
+    /**
+     * Computing relative destination. This is because, cpy is buggy when
+     * outDir is an absolute path.
+     */
+    const destination = isAbsolute(outDir) ? relative(cwd, outDir) : outDir;
+    debug('copying files %O to destination "%s"', filePaths, destination);
+    return cpy(filePaths.filter(isNotJunk), destination, {
+        cwd: cwd,
+        flat: false,
+    });
+}