@adonisjs/core 5.8.9 → 6.0.0-0

package/build/src/Ignitor/HttpServer/index.d.ts

@@ -1,56 +0,0 @@
-import { CustomServerCallback } from '@ioc:Adonis/Core/TestUtils';
-import { AppKernel } from '../Kernel';
-/**
- * Exposes the API to setup the application for starting the HTTP
- * server.
- *
- * - Calling "kill" explicitly exists the process.
- * - The "error" event emitted on the server instance explicitly exists the process.
- * - SIGINT and in some case SIGTERM explicitly exists the process.
- */
-export declare class HttpServer {
-    private appRoot;
-    /**
-     * Reference to the HTTP server.
-     */
-    private server;
-    /**
-     * Reference to the app kernel
-     */
-    kernel: AppKernel;
-    application: import("@adonisjs/application").Application;
-    constructor(appRoot: string);
-    /**
-     * Closes the underlying HTTP server
-     */
-    private closeHttpServer;
-    /**
-     * Monitors the HTTP server for close and error events, so that
-     * we can perform a graceful shutdown.
-     */
-    private monitorHttpServer;
-    /**
-     * Creates the HTTP server to handle incoming requests. The server is just
-     * created but not listening on any port.
-     */
-    createServer(serverCallback?: CustomServerCallback): void;
-    /**
-     * Starts the http server a given host and port
-     */
-    listen(): Promise<void>;
-    /**
-     * Start the HTTP server by wiring up the application
-     */
-    start(serverCallback?: CustomServerCallback): Promise<void>;
-    /**
-     * Prepares the application for shutdown. This method will invoke `shutdown`
-     * lifecycle method on the providers and closes the `httpServer`.
-     */
-    close(): Promise<void>;
-    /**
-     * Kills the http server process by attempting to perform a graceful
-     * shutdown or killing the app forcefully as waiting for configured
-     * seconds.
-     */
-    kill(waitTimeout?: number): Promise<void>;
-}

package/build/src/Ignitor/HttpServer/index.js

@@ -1,127 +0,0 @@
-"use strict";
-/*
- * @adonisjs/core
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HttpServer = void 0;
-const Kernel_1 = require("../Kernel");
-const utils_1 = require("../../utils");
-/**
- * Exposes the API to setup the application for starting the HTTP
- * server.
- *
- * - Calling "kill" explicitly exists the process.
- * - The "error" event emitted on the server instance explicitly exists the process.
- * - SIGINT and in some case SIGTERM explicitly exists the process.
- */
-class HttpServer {
-    constructor(appRoot) {
-        this.appRoot = appRoot;
-        /**
-         * Reference to the app kernel
-         */
-        this.kernel = new Kernel_1.AppKernel(this.appRoot, 'web');
-        this.application = this.kernel.application;
-    }
-    /**
-     * Closes the underlying HTTP server
-     */
-    closeHttpServer() {
-        return new Promise((resolve) => this.server.instance.close(() => resolve()));
-    }
-    /**
-     * Monitors the HTTP server for close and error events, so that
-     * we can perform a graceful shutdown.
-     */
-    monitorHttpServer() {
-        this.server.instance.on('close', async () => {
-            this.application.logger.trace('closing http server');
-            this.server.instance.removeAllListeners();
-            this.application.isShuttingDown = true;
-        });
-        this.server.instance.on('error', async (error) => {
-            this.application.logger.error(error, error.message);
-            await this.kill(3000);
-        });
-    }
-    /**
-     * Creates the HTTP server to handle incoming requests. The server is just
-     * created but not listening on any port.
-     */
-    createServer(serverCallback) {
-        this.server = this.application.container.use('Adonis/Core/Server');
-        (0, utils_1.createHttpServer)(this.application, this.server, serverCallback);
-    }
-    /**
-     * Starts the http server a given host and port
-     */
-    listen() {
-        return new Promise(async (resolve, reject) => {
-            try {
-                await this.kernel.start(() => this.close());
-                const host = this.application.env.get('HOST', '0.0.0.0');
-                const port = Number(this.application.env.get('PORT', '3333'));
-                this.server.instance.listen(port, host, () => {
-                    this.application.logger.info('started server on %s:%s', host, port);
-                    this.kernel.ready({ port: port, host: host });
-                    resolve();
-                });
-            }
-            catch (error) {
-                reject(error);
-            }
-        });
-    }
-    /**
-     * Start the HTTP server by wiring up the application
-     */
-    async start(serverCallback) {
-        try {
-            await this.kernel.boot();
-            this.createServer(serverCallback);
-            this.monitorHttpServer();
-            await this.listen();
-        }
-        catch (error) {
-            await this.kernel.handleError(error);
-        }
-    }
-    /**
-     * Prepares the application for shutdown. This method will invoke `shutdown`
-     * lifecycle method on the providers and closes the `httpServer`.
-     */
-    async close() {
-        /**
-         * Close the HTTP server before excuting the `shutdown` hooks. This ensures that
-         * we are not accepting any new request during cool off.
-         */
-        await this.closeHttpServer();
-        await this.kernel.close();
-    }
-    /**
-     * Kills the http server process by attempting to perform a graceful
-     * shutdown or killing the app forcefully as waiting for configured
-     * seconds.
-     */
-    async kill(waitTimeout = 3000) {
-        this.application.logger.trace('forcefully killing http server');
-        try {
-            await Promise.race([
-                this.close(),
-                new Promise((resolve) => {
-                    setTimeout(resolve, waitTimeout);
-                }),
-            ]);
-            process.exit(0);
-        }
-        catch (error) {
-            await this.kernel.handleError(error).finally(() => process.exit(1));
-        }
-    }
-}
-exports.HttpServer = HttpServer;

package/build/src/Ignitor/Kernel/index.d.ts

@@ -1,56 +0,0 @@
-import { Application } from '@adonisjs/application';
-import { AppEnvironments } from '@ioc:Adonis/Core/Application';
-import { SignalsListener } from '../SignalsListener';
-/**
- * Kernel to manage application state
- */
-export declare class AppKernel {
-    /**
-     * Reference to application instance
-     */
-    application: Application;
-    /**
-     * Reference to signals listener
-     */
-    signalsListener: SignalsListener;
-    /**
-     * Find if the application has been booted or not
-     */
-    hasBooted: boolean;
-    /**
-     * Avoiding duplicate registeration of ts compiler hook
-     */
-    private hasRegisteredTsHook;
-    constructor(appRoot: string, environment: AppEnvironments);
-    /**
-     * Pretty prints a given error on the terminal
-     */
-    private prettyPrintError;
-    /**
-     * Boot the application. The process for booting the app remains the
-     * same regardless of the process environment.
-     */
-    boot(): Promise<void>;
-    /**
-     * Registers the TS compiler to hook into node require and
-     * process TypeScript files
-     */
-    registerTsCompilerHook(): void;
-    /**
-     * Start the application. The callback is required to listen
-     * for close signals
-     */
-    start(shutdownCallback?: () => Promise<void>): Promise<() => Promise<void>>;
-    /**
-     * Notify that process is ready
-     */
-    ready(eventPayload: Record<string, any>): void;
-    /**
-     * Prepare application for shutdown
-     */
-    close(): Promise<void>;
-    /**
-     * Handles ignitor boot errors
-     */
-    handleError(error: any): Promise<void>;
-}

package/build/src/Ignitor/Kernel/index.js

@@ -1,123 +0,0 @@
-"use strict";
-/*
- * @adonisjs/core
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AppKernel = void 0;
-const application_1 = require("@adonisjs/application");
-const utils_1 = require("../../utils");
-const SignalsListener_1 = require("../SignalsListener");
-/**
- * Kernel to manage application state
- */
-class AppKernel {
-    constructor(appRoot, environment) {
-        /**
-         * Find if the application has been booted or not
-         */
-        this.hasBooted = false;
-        /**
-         * Avoiding duplicate registeration of ts compiler hook
-         */
-        this.hasRegisteredTsHook = false;
-        this.application = new application_1.Application(appRoot, environment);
-        this.signalsListener = new SignalsListener_1.SignalsListener(this.application);
-    }
-    /**
-     * Pretty prints a given error on the terminal
-     */
-    async prettyPrintError(error) {
-        try {
-            const Youch = require('youch');
-            const output = await new Youch(error, {}).toJSON();
-            console.log(require('youch-terminal')(output));
-        }
-        catch {
-            console.log(error.stack);
-        }
-    }
-    /**
-     * Boot the application. The process for booting the app remains the
-     * same regardless of the process environment.
-     */
-    async boot() {
-        if (this.hasBooted) {
-            return;
-        }
-        /**
-         * Setting up the application.
-         */
-        await this.application.setup();
-        /**
-         * Registering providers
-         */
-        await this.application.registerProviders();
-        /**
-         * Booting providers
-         */
-        await this.application.bootProviders();
-        /**
-         * Importing preloaded files
-         */
-        await this.application.requirePreloads();
-        this.hasBooted = true;
-    }
-    /**
-     * Registers the TS compiler to hook into node require and
-     * process TypeScript files
-     */
-    registerTsCompilerHook() {
-        /**
-         * Register ts hook when running typescript code directly
-         */
-        if (this.application.rcFile.typescript && !this.hasRegisteredTsHook) {
-            this.hasRegisteredTsHook = true;
-            (0, utils_1.registerTsHook)(this.application.appRoot);
-        }
-    }
-    /**
-     * Start the application. The callback is required to listen
-     * for close signals
-     */
-    async start(shutdownCallback) {
-        await this.application.start();
-        this.signalsListener.listen(shutdownCallback || (() => this.close()));
-        return () => this.close();
-    }
-    /**
-     * Notify that process is ready
-     */
-    ready(eventPayload) {
-        if (process.send) {
-            process.send('ready');
-            process.send({ isAdonisJS: true, environment: this.application.environment, ...eventPayload });
-        }
-    }
-    /**
-     * Prepare application for shutdown
-     */
-    async close() {
-        this.signalsListener.cleanup();
-        await this.application.shutdown();
-    }
-    /**
-     * Handles ignitor boot errors
-     */
-    async handleError(error) {
-        if (typeof error.handle === 'function') {
-            await error.handle(error);
-        }
-        else if (this.application.inDev) {
-            await this.prettyPrintError(error);
-        }
-        else {
-            console.error(error.stack);
-        }
-    }
-}
-exports.AppKernel = AppKernel;

package/build/src/Ignitor/SignalsListener/index.d.ts

@@ -1,23 +0,0 @@
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-/**
- * Exposes the API to invoke a callback when `SIGTERM` or
- * `SIGINT (pm2 only)` signals are received.
- */
-export declare class SignalsListener {
-    private application;
-    protected onCloseCallback?: () => Promise<void>;
-    /**
-     * Invoke callback and exit process
-     */
-    private kill;
-    constructor(application: ApplicationContract);
-    /**
-     * Listens for exit signals and invokes the given
-     * callback
-     */
-    listen(callback: () => Promise<void>): void;
-    /**
-     * Cleanup event listeners
-     */
-    cleanup(): void;
-}

package/build/src/Ignitor/SignalsListener/index.js

@@ -1,66 +0,0 @@
-"use strict";
-/*
- * @adonisjs/core
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SignalsListener = void 0;
-/**
- * Exposes the API to invoke a callback when `SIGTERM` or
- * `SIGINT (pm2 only)` signals are received.
- */
-class SignalsListener {
-    constructor(application) {
-        this.application = application;
-        /**
-         * Invoke callback and exit process
-         */
-        this.kill = async function () {
-            try {
-                await Promise.race([
-                    this.onCloseCallback(),
-                    new Promise((resolve) => {
-                        setTimeout(resolve, 3000);
-                    }),
-                ]);
-                process.exit(0);
-            }
-            catch (error) {
-                process.exit(1);
-            }
-        }.bind(this);
-    }
-    /**
-     * Listens for exit signals and invokes the given
-     * callback
-     */
-    listen(callback) {
-        this.onCloseCallback = callback;
-        /**
-         * Close on SIGINT AND SIGTERM SIGNALS
-         */
-        if (process.env.pm_id) {
-            process.on('SIGINT', this.kill);
-        }
-        process.on('SIGTERM', this.kill);
-        /**
-         * Notify about uncaught exceptions
-         */
-        process.on('uncaughtExceptionMonitor', (error) => {
-            this.application.logger.fatal(error, '"uncaughtException" detected');
-        });
-    }
-    /**
-     * Cleanup event listeners
-     */
-    cleanup() {
-        process.removeListener('SIGINT', this.kill);
-        process.removeListener('SIGTERM', this.kill);
-        this.onCloseCallback = undefined;
-    }
-}
-exports.SignalsListener = SignalsListener;

package/build/src/Ignitor/index.d.ts

@@ -1,32 +0,0 @@
-import { Application } from '@adonisjs/application';
-import { AppEnvironments } from '@ioc:Adonis/Core/Application';
-import { Ace } from './Ace';
-import { HttpServer } from './HttpServer';
-import { AppKernel } from './Kernel';
-/**
- * Ignitor is used to wireup different pieces of AdonisJs to bootstrap
- * the application.
- */
-export declare class Ignitor {
-    private appRoot;
-    constructor(appRoot: string);
-    /**
-     * Returns an instance of the application.
-     */
-    application(environment: AppEnvironments): Application;
-    /**
-     * Returns instance of server to start
-     * the HTTP server
-     */
-    httpServer(): HttpServer;
-    /**
-     * Returns instance of server to start
-     * the HTTP server
-     */
-    kernel(environment: AppEnvironments): AppKernel;
-    /**
-     * Returns instance of ace to handle console
-     * commands
-     */
-    ace(): Ace;
-}

package/build/src/Ignitor/index.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Ignitor = void 0;
-/*
- * @adonisjs/core
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-const path_1 = require("path");
-const url_1 = require("url");
-const application_1 = require("@adonisjs/application");
-const Ace_1 = require("./Ace");
-const HttpServer_1 = require("./HttpServer");
-const Kernel_1 = require("./Kernel");
-/**
- * Ignitor is used to wireup different pieces of AdonisJs to bootstrap
- * the application.
- */
-class Ignitor {
-    constructor(appRoot) {
-        /**
-         * In ESM, ignitor is constructed with `import.meta.url`. Normalize
-         * the file URL to an absolute directory path.
-         */
-        this.appRoot = appRoot.startsWith('file:') ? (0, path_1.dirname)((0, url_1.fileURLToPath)(appRoot)) : appRoot;
-    }
-    /**
-     * Returns an instance of the application.
-     */
-    application(environment) {
-        return new application_1.Application(this.appRoot, environment);
-    }
-    /**
-     * Returns instance of server to start
-     * the HTTP server
-     */
-    httpServer() {
-        return new HttpServer_1.HttpServer(this.appRoot);
-    }
-    /**
-     * Returns instance of server to start
-     * the HTTP server
-     */
-    kernel(environment) {
-        return new Kernel_1.AppKernel(this.appRoot, environment);
-    }
-    /**
-     * Returns instance of ace to handle console
-     * commands
-     */
-    ace() {
-        return new Ace_1.Ace(this.appRoot);
-    }
-}
-exports.Ignitor = Ignitor;

package/build/src/TestUtils/HttpServer/index.d.ts

@@ -1,27 +0,0 @@
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-import { CustomServerCallback } from '@ioc:Adonis/Core/TestUtils';
-/**
- * The test HTTP server to handle and serve HTTP request
- */
-export declare class TestHttpServer {
-    application: ApplicationContract;
-    private server;
-    constructor(application: ApplicationContract);
-    /**
-     * Creates the HTTP server to handle incoming requests. The server is just
-     * created but not listening on any port.
-     */
-    private create;
-    /**
-     * Start the HTTP server to listen for incoming requests
-     */
-    private listen;
-    /**
-     * Close HTTP server from listening to any requests
-     */
-    close(): Promise<void>;
-    /**
-     * Start the test HTTP server
-     */
-    start(serverCallback?: CustomServerCallback): Promise<() => Promise<void>>;
-}

package/build/src/TestUtils/HttpServer/index.js

@@ -1,56 +0,0 @@
-"use strict";
-/*
- * @adonisjs/core
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TestHttpServer = void 0;
-const utils_1 = require("../../utils");
-/**
- * The test HTTP server to handle and serve HTTP request
- */
-class TestHttpServer {
-    constructor(application) {
-        this.application = application;
-    }
-    /**
-     * Creates the HTTP server to handle incoming requests. The server is just
-     * created but not listening on any port.
-     */
-    create(serverCallback) {
-        this.server = this.application.container.use('Adonis/Core/Server');
-        (0, utils_1.createHttpServer)(this.application, this.server, serverCallback);
-    }
-    /**
-     * Start the HTTP server to listen for incoming requests
-     */
-    listen() {
-        const host = this.application.env.get('HOST', '0.0.0.0');
-        const port = Number(this.application.env.get('PORT', '3333'));
-        return new Promise((resolve) => {
-            this.server.instance.listen(port, host, () => {
-                this.application.logger.info('started server on %s:%s', host, port);
-                resolve();
-            });
-        });
-    }
-    /**
-     * Close HTTP server from listening to any requests
-     */
-    close() {
-        return new Promise((resolve) => this.server.instance.close(() => resolve()));
-    }
-    /**
-     * Start the test HTTP server
-     */
-    async start(serverCallback) {
-        this.create(serverCallback);
-        await this.listen();
-        return () => this.close();
-    }
-}
-exports.TestHttpServer = TestHttpServer;

package/build/src/TestUtils/index.d.ts

@@ -1,24 +0,0 @@
-import { Macroable } from 'macroable';
-import { TestUtilsContract } from '@ioc:Adonis/Core/TestUtils';
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-import { TestHttpServer } from './HttpServer';
-/**
- * Test utils module is meant to be extended to add custom
- * utilities required for testing AdonisJS applications.
- */
-export declare class TestUtils extends Macroable implements Omit<TestUtilsContract, 'constructor'> {
-    application: ApplicationContract;
-    static macros: {};
-    static getters: {};
-    constructor(application: ApplicationContract);
-    /**
-     * Utilities for ace
-     */
-    ace(): {
-        loadCommands: () => Promise<void>;
-    };
-    /**
-     * Utilities for http server
-     */
-    httpServer(): TestHttpServer;
-}