@adonisjs/assembler 6.1.3-3 → 6.1.3-5

package/build/src/test_runner.js

@@ -0,0 +1,178 @@
+import picomatch from 'picomatch';
+import { cliui } from '@poppinss/cliui';
+import { AssetsDevServer } from './assets_dev_server.js';
+import { getPort, isDotEnvFile, runNode, watch } from './helpers.js';
+const ui = cliui();
+export class TestRunner {
+    #cwd;
+    #logger = ui.logger;
+    #options;
+    #scriptFile = 'bin/test.js';
+    #isMetaFile;
+    #isTestFile;
+    #isBusy = false;
+    #onError;
+    #onClose;
+    #testScript;
+    #watcher;
+    #assetsServer;
+    get #colors() {
+        return this.#logger.getColors();
+    }
+    constructor(cwd, options) {
+        this.#cwd = cwd;
+        this.#options = options;
+        this.#isMetaFile = picomatch((this.#options.metaFiles || []).map(({ pattern }) => pattern));
+        this.#isTestFile = picomatch(this.#options.suites
+            .filter((suite) => {
+            if (this.#options.filters.suites) {
+                this.#options.filters.suites.includes(suite.name);
+            }
+            return true;
+        })
+            .map((suite) => suite.files)
+            .flat(1));
+    }
+    #convertFiltersToArgs(filters) {
+        const args = [];
+        if (filters.suites) {
+            args.push(...filters.suites);
+        }
+        if (filters.files) {
+            args.push('--files');
+            args.push(filters.files.join(','));
+        }
+        if (filters.groups) {
+            args.push('--groups');
+            args.push(filters.groups.join(','));
+        }
+        if (filters.tags) {
+            args.push('--tags');
+            args.push(filters.tags.join(','));
+        }
+        if (filters.ignoreTags) {
+            args.push('--ignore-tags');
+            args.push(filters.ignoreTags.join(','));
+        }
+        if (filters.tests) {
+            args.push('--ignore-tests');
+            args.push(filters.tests.join(','));
+        }
+        if (filters.match) {
+            args.push('--match');
+            args.push(filters.match.join(','));
+        }
+        return args;
+    }
+    #clearScreen() {
+        if (this.#options.clearScreen) {
+            process.stdout.write('\u001Bc');
+        }
+    }
+    #runTests(port, filtersArgs, mode) {
+        this.#isBusy = true;
+        this.#testScript = runNode(this.#cwd, {
+            script: this.#scriptFile,
+            env: { PORT: port, ...this.#options.env },
+            nodeArgs: this.#options.nodeArgs,
+            scriptArgs: filtersArgs.concat(this.#options.scriptArgs),
+        });
+        this.#testScript
+            .then((result) => {
+            if (mode === 'nonblocking') {
+                this.#onClose?.(result.exitCode);
+                this.#watcher?.close();
+                this.#assetsServer?.stop();
+            }
+        })
+            .catch((error) => {
+            this.#logger.warning(`unable to run test script "${this.#scriptFile}"`);
+            this.#logger.fatal(error);
+            this.#onError?.(error);
+            this.#watcher?.close();
+            this.#assetsServer?.stop();
+        })
+            .finally(() => {
+            this.#isBusy = false;
+        });
+    }
+    #startAssetsServer() {
+        this.#assetsServer = new AssetsDevServer(this.#cwd, this.#options.assets);
+        this.#assetsServer.start();
+    }
+    #handleFileChange(action, port, filters, relativePath) {
+        if (this.#isBusy) {
+            return;
+        }
+        if (isDotEnvFile(relativePath) || this.#isMetaFile(relativePath)) {
+            this.#clearScreen();
+            this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
+            this.#runTests(port, filters, 'blocking');
+        }
+    }
+    #handleSourceFileChange(action, port, filters, relativePath) {
+        if (this.#isBusy) {
+            return;
+        }
+        this.#clearScreen();
+        this.#logger.log(`${this.#colors.green(action)} ${relativePath}`);
+        if (this.#isTestFile(relativePath)) {
+            this.#runTests(port, this.#convertFiltersToArgs({
+                ...this.#options.filters,
+                files: [relativePath],
+            }), 'blocking');
+            return;
+        }
+        this.#runTests(port, filters, 'blocking');
+    }
+    setLogger(logger) {
+        this.#logger = logger;
+        this.#assetsServer?.setLogger(logger);
+        return this;
+    }
+    onClose(callback) {
+        this.#onClose = callback;
+        return this;
+    }
+    onError(callback) {
+        this.#onError = callback;
+        return this;
+    }
+    async run() {
+        const port = String(await getPort(this.#cwd));
+        const initialFilters = this.#convertFiltersToArgs(this.#options.filters);
+        this.#clearScreen();
+        this.#startAssetsServer();
+        this.#logger.info('booting application to run tests...');
+        this.#runTests(port, initialFilters, 'nonblocking');
+    }
+    async runAndWatch(ts, options) {
+        const port = String(await getPort(this.#cwd));
+        const initialFilters = this.#convertFiltersToArgs(this.#options.filters);
+        this.#clearScreen();
+        this.#startAssetsServer();
+        this.#logger.info('booting application to run tests...');
+        this.#runTests(port, initialFilters, 'blocking');
+        const output = watch(this.#cwd, ts, options || {});
+        if (!output) {
+            this.#onClose?.(1);
+            return;
+        }
+        this.#watcher = output.chokidar;
+        output.watcher.on('watcher:ready', () => {
+            this.#logger.info('watching file system for changes...');
+        });
+        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.#handleSourceFileChange('add', port, initialFilters, relativePath));
+        output.watcher.on('source:change', ({ relativePath }) => this.#handleSourceFileChange('update', port, initialFilters, relativePath));
+        output.watcher.on('source:unlink', ({ relativePath }) => this.#handleSourceFileChange('delete', port, initialFilters, relativePath));
+        output.watcher.on('add', ({ relativePath }) => this.#handleFileChange('add', port, initialFilters, relativePath));
+        output.watcher.on('change', ({ relativePath }) => this.#handleFileChange('update', port, initialFilters, relativePath));
+        output.watcher.on('unlink', ({ relativePath }) => this.#handleFileChange('delete', port, initialFilters, relativePath));
+    }
+}

package/build/src/types.d.ts

@@ -13,12 +13,18 @@ export type MetaFile = {
     pattern: string;
     reloadServer: boolean;
 };
+export type Suite = {
+    files: string[];
+    name: string;
+};
 export type AssetsBundlerOptions = {
     serve: false;
+    args?: string[];
     driver?: string;
     cmd?: string;
 } | {
     serve: true;
+    args: string[];
     driver: string;
     cmd: string;
 };
@@ -30,7 +36,26 @@ export type DevServerOptions = {
     metaFiles?: MetaFile[];
     assets?: AssetsBundlerOptions;
 };
+export type TestRunnerOptions = {
+    filters: Partial<{
+        tests: string[];
+        suites: string[];
+        groups: string[];
+        files: string[];
+        match: string[];
+        tags: string[];
+        ignoreTags: string[];
+    }>;
+    scriptArgs: string[];
+    nodeArgs: string[];
+    clearScreen?: boolean;
+    env?: NodeJS.ProcessEnv;
+    metaFiles?: MetaFile[];
+    assets?: AssetsBundlerOptions;
+    suites: Suite[];
+};
 export type BundlerOptions = {
     metaFiles?: MetaFile[];
     assets?: AssetsBundlerOptions;
 };
+//# sourceMappingURL=types.d.ts.map

package/build/src/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":";AAYA,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAA;CACxB,CAAA;AAKD,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,OAAO,CAAA;CACf,CAAA;AAKD,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,OAAO,CAAA;CACtB,CAAA;AAKD,MAAM,MAAM,KAAK,GAAG;IAClB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAKD,MAAM,MAAM,oBAAoB,GAC5B;IACE,KAAK,EAAE,KAAK,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;CACb,GACD;IACE,KAAK,EAAE,IAAI,CAAA;IACX,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,EAAE,MAAM,CAAA;IACd,GAAG,EAAE,MAAM,CAAA;CACZ,CAAA;AAKL,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAA;IACvB,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B,CAAA;AAKD,MAAM,MAAM,iBAAiB,GAAG;IAK9B,OAAO,EAAE,OAAO,CAAC;QACf,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,MAAM,EAAE,MAAM,EAAE,CAAA;QAChB,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,KAAK,EAAE,MAAM,EAAE,CAAA;QACf,IAAI,EAAE,MAAM,EAAE,CAAA;QACd,UAAU,EAAE,MAAM,EAAE,CAAA;KACrB,CAAC,CAAA;IAMF,UAAU,EAAE,MAAM,EAAE,CAAA;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC,UAAU,CAAA;IACvB,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,oBAAoB,CAAA;IAC7B,MAAM,EAAE,KAAK,EAAE,CAAA;CAChB,CAAA;AAKD,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,oBAAoB,CAAA;CAC9B,CAAA"}

package/index.ts

@@ -0,0 +1,12 @@
+/*
+ * @adonisjs/assembler
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+export { Bundler } from './src/bundler.js'
+export { DevServer } from './src/dev_server.js'
+export { TestRunner } from './src/test_runner.js'

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@adonisjs/assembler",
-  "version": "6.1.3-3",
+  "version": "6.1.3-5",
   "description": "Provides utilities to run AdonisJS development server and build project for production",
   "main": "build/index.js",
   "type": "module",
   "files": [
+    "src",
+    "index.ts",
     "build/src",
     "build/index.d.ts",
+    "build/index.d.ts.map",
     "build/index.js"
   ],
   "exports": {
@@ -35,34 +38,34 @@
   "author": "virk,adonisjs",
   "license": "MIT",
   "devDependencies": {
-    "@commitlint/cli": "^17.4.4",
-    "@commitlint/config-conventional": "^17.4.4",
+    "@commitlint/cli": "^17.6.1",
+    "@commitlint/config-conventional": "^17.6.1",
     "@japa/assert": "^1.4.1",
     "@japa/file-system": "^1.0.1",
     "@japa/run-failed-tests": "^1.1.1",
     "@japa/runner": "^2.5.1",
     "@japa/spec-reporter": "^1.3.3",
-    "@swc/core": "^1.3.39",
-    "@types/node": "^18.15.0",
+    "@swc/core": "^1.3.51",
+    "@types/node": "^18.15.11",
     "c8": "^7.13.0",
     "cross-env": "^7.0.3",
     "del-cli": "^5.0.0",
-    "eslint": "^8.36.0",
-    "eslint-config-prettier": "^8.7.0",
+    "eslint": "^8.38.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-adonis": "^3.0.3",
     "eslint-plugin-prettier": "^4.2.1",
     "github-label-sync": "^2.3.1",
     "husky": "^8.0.3",
-    "np": "^7.6.3",
+    "np": "^7.7.0",
     "p-event": "^5.0.1",
-    "prettier": "^2.8.4",
+    "prettier": "^2.8.7",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.5"
+    "typescript": "^5.0.4"
   },
   "dependencies": {
-    "@adonisjs/env": "^4.2.0-1",
-    "@poppinss/chokidar-ts": "^4.1.0-1",
-    "@poppinss/cliui": "^6.1.1-1",
+    "@adonisjs/env": "^4.2.0-2",
+    "@poppinss/chokidar-ts": "^4.1.0-3",
+    "@poppinss/cliui": "^6.1.1-2",
     "@types/picomatch": "^2.3.0",
     "cpy": "^9.0.1",
     "execa": "^7.0.0",

package/src/assets_dev_server.ts

@@ -0,0 +1,182 @@
+/*
+ * @adonisjs/core
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+import type { ExecaChildProcess } from 'execa'
+import { type Logger, cliui } from '@poppinss/cliui'
+
+import { run } from './helpers.js'
+import type { AssetsBundlerOptions } from './types.js'
+
+/**
+ * Instance of CLIUI
+ */
+const ui = cliui()
+
+/**
+ * Exposes the API to start the development server for processing assets during
+ * development.
+ *
+ * - Here we are running the assets dev server in a child process.
+ * - Piping the output from the child process and reformatting it before writing it to
+ *   process streams.
+ *
+ * AssetsDevServer is agnostic and can run any assets dev server. Be it Vite or Encore or
+ * even Webpack directly.
+ */
+export class AssetsDevServer {
+  #cwd: URL
+  #logger = ui.logger
+  #options?: AssetsBundlerOptions
+  #devServer?: ExecaChildProcess<string>
+
+  /**
+   * Getting reference to colors library from logger
+   */
+  get #colors() {
+    return this.#logger.getColors()
+  }
+
+  constructor(cwd: URL, options?: AssetsBundlerOptions) {
+    this.#cwd = cwd
+    this.#options = options
+  }
+
+  /**
+   * Logs messages from vite dev server stdout and stderr
+   */
+  #logViteDevServerMessage(data: Buffer) {
+    const dataString = data.toString()
+    const lines = dataString.split('\n')
+
+    /**
+     * Logging VITE ready in message with proper
+     * spaces and newlines
+     */
+    if (dataString.includes('ready in')) {
+      console.log('')
+      console.log(dataString.trim())
+      return
+    }
+
+    /**
+     * Put a wrapper around vite network address log
+     */
+    if (dataString.includes('Local') && dataString.includes('Network')) {
+      const sticker = ui.sticker().useColors(this.#colors).useRenderer(this.#logger.getRenderer())
+
+      lines.forEach((line: string) => {
+        if (line.trim()) {
+          sticker.add(line)
+        }
+      })
+
+      sticker.render()
+      return
+    }
+
+    /**
+     * Log rest of the lines
+     */
+    lines.forEach((line: string) => {
+      if (line.trim()) {
+        console.log(line)
+      }
+    })
+  }
+
+  /**
+   * Logs messages from assets dev server stdout and stderr
+   */
+  #logAssetsDevServerMessage(data: Buffer) {
+    const dataString = data.toString()
+    const lines = dataString.split('\n')
+    lines.forEach((line: string) => {
+      if (line.trim()) {
+        console.log(line)
+      }
+    })
+  }
+
+  /**
+   * Set a custom CLI UI logger
+   */
+  setLogger(logger: Logger) {
+    this.#logger = logger
+    return this
+  }
+
+  /**
+   * Starts the assets bundler server. The assets bundler server process is
+   * considered as the secondary process and therefore we do not perform
+   * any cleanup if it dies.
+   */
+  start() {
+    if (!this.#options?.serve) {
+      return
+    }
+
+    this.#logger.info(`starting "${this.#options.driver}" dev server...`)
+
+    /**
+     * Create child process
+     */
+    this.#devServer = run(this.#cwd, {
+      script: this.#options.cmd,
+
+      /**
+       * We do not inherit the stdio for vite and encore, because in
+       * inherit mode they own the stdin and interrupts the
+       * `Ctrl + C` command.
+       */
+      stdio: 'pipe',
+      scriptArgs: this.#options.args,
+    })
+
+    /**
+     * Log child process messages
+     */
+    this.#devServer.stdout?.on('data', (data) => {
+      if (this.#options!.driver === 'vite') {
+        this.#logViteDevServerMessage(data)
+      } else {
+        this.#logAssetsDevServerMessage(data)
+      }
+    })
+
+    this.#devServer.stderr?.on('data', (data) => {
+      if (this.#options!.driver === 'vite') {
+        this.#logViteDevServerMessage(data)
+      } else {
+        this.#logAssetsDevServerMessage(data)
+      }
+    })
+
+    this.#devServer
+      .then((result) => {
+        this.#logger.warning(
+          `"${this.#options!.driver}" dev server closed with status code "${result.exitCode}"`
+        )
+      })
+      .catch((error) => {
+        this.#logger.warning(`unable to connect to "${this.#options!.driver}" dev server`)
+        this.#logger.fatal(error)
+      })
+  }
+
+  /**
+   * Stop the dev server
+   */
+  stop() {
+    if (this.#devServer) {
+      this.#devServer.removeAllListeners()
+      this.#devServer.kill('SIGKILL')
+      this.#devServer = undefined
+    }
+  }
+}