@adonisjs/core 5.8.9 → 6.0.0-0

package/build/src/HttpExceptionHandler/index.js

@@ -1,213 +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.HttpExceptionHandler = void 0;
-/**
- * Http exception handler serves as the base exception handler
- * to handle all exceptions occured during the HTTP request
- * lifecycle and makes appropriate response for them.
- */
-class HttpExceptionHandler {
-    constructor(logger) {
-        this.logger = logger;
-        /**
-         * An array of error codes that must not be reported
-         */
-        this.ignoreCodes = [];
-        /**
-         * An array of http statuses that must not be reported. The first
-         * level of filteration is on the basis of statuses and then
-         * the error codes.
-         */
-        this.ignoreStatuses = [400, 422, 401];
-        /**
-         * An array of internal error codes to ignore
-         * from the reporting list
-         */
-        this.internalIgnoreCodes = ['E_ROUTE_NOT_FOUND'];
-        /**
-         * Map of status pages to render, instead of making the
-         * regular response
-         */
-        this.statusPages = {};
-        /**
-         * A flag to disable status pages during development
-         */
-        this.disableStatusPagesInDevelopment = true;
-    }
-    /**
-     * A custom context to send to the logger when reporting
-     * errors.
-     */
-    context(ctx) {
-        const requestId = ctx.request.id();
-        return requestId
-            ? {
-                'x-request-id': requestId,
-            }
-            : {};
-    }
-    /**
-     * Returns a boolean telling if a given error is supposed
-     * to be logged or not
-     */
-    shouldReport(error) {
-        /**
-         * Do not report the error when it's status is mentioned inside
-         * the `ignoreStatuses` array.
-         */
-        if (error.status && this.ignoreStatuses.indexOf(error.status) > -1) {
-            return false;
-        }
-        /**
-         * Don't report when error has a code and it's in the ignore list.
-         */
-        if (error.code && this.ignoreCodes.concat(this.internalIgnoreCodes).indexOf(error.code) > -1) {
-            return false;
-        }
-        return true;
-    }
-    /**
-     * Makes the JSON response, based upon the environment in
-     * which the app is runing
-     */
-    async makeJSONResponse(error, ctx) {
-        if (process.env.NODE_ENV === 'development') {
-            ctx.response.status(error.status).send({
-                message: error.message,
-                stack: error.stack,
-                code: error.code,
-            });
-            return;
-        }
-        ctx.response.status(error.status).send({ message: error.message });
-    }
-    /**
-     * Makes the JSON API response, based upon the environment in
-     * which the app is runing
-     */
-    async makeJSONAPIResponse(error, ctx) {
-        ctx.response.status(error.status).send({
-            errors: [
-                {
-                    title: error.message,
-                    ...(process.env.NODE_ENV === 'development' ? { detail: error.stack } : {}),
-                    code: error.code,
-                    status: error.status,
-                },
-            ],
-        });
-    }
-    /**
-     * Makes the HTML response, based upon the environment in
-     * which the app is runing
-     */
-    async makeHtmlResponse(error, ctx) {
-        if (process.env.NODE_ENV === 'development' &&
-            (!this.expandedStatusPages[error.status] || this.disableStatusPagesInDevelopment)) {
-            const Youch = require('youch');
-            const html = await new Youch(error, ctx.request.request).toHTML();
-            ctx.response.status(error.status).send(html);
-            return;
-        }
-        /**
-         * Render status pages
-         */
-        if (ctx['view'] && this.expandedStatusPages[error.status]) {
-            const html = await ctx['view'].render(this.expandedStatusPages[error.status], { error });
-            ctx.response.status(error.status).send(html);
-            return;
-        }
-        ctx.response.status(error.status).send(`<h1> ${error.message} </h1>`);
-    }
-    /**
-     * Report a given error
-     */
-    report(error, ctx) {
-        error.status = error.status || 500;
-        if (!this.shouldReport(error)) {
-            return;
-        }
-        if (typeof error.report === 'function') {
-            error.report(error, ctx);
-            return;
-        }
-        /**
-         * - Using `error` for `500 and above`
-         * - `warn` for `400 and above`
-         * - `info` for rest. This should not happen, but technically it's possible for someone
-         *    to raise with 200
-         */
-        if (!error.status || error.status >= 500) {
-            if (process.env.NODE_ENV !== 'test') {
-                ctx.logger.error({ err: error, ...this.context(ctx) }, error.message);
-            }
-        }
-        else if (error.status >= 400) {
-            ctx.logger.warn(this.context(ctx), error.message);
-        }
-        else {
-            ctx.logger.info(this.context(ctx), error.message);
-        }
-    }
-    /**
-     * Handle exception and make response
-     */
-    async handle(error, ctx) {
-        error.status = error.status || 500;
-        if (typeof error.handle === 'function') {
-            return error.handle(error, ctx);
-        }
-        /**
-         * Send stack in the response when in test environment and
-         * there is a fatal error.
-         */
-        if (error.status >= 500 && error.stack && process.env.NODE_ENV === 'test') {
-            return ctx.response.status(error.status).send(error.stack);
-        }
-        /**
-         * Attempt to find the best error reporter for validation
-         */
-        switch (ctx.request.accepts(['html', 'application/vnd.api+json', 'json'])) {
-            case 'html':
-            case null:
-                return this.makeHtmlResponse(error, ctx);
-            case 'json':
-                return this.makeJSONResponse(error, ctx);
-            case 'application/vnd.api+json':
-                return this.makeJSONAPIResponse(error, ctx);
-        }
-    }
-}
-exports.HttpExceptionHandler = HttpExceptionHandler;
-/**
- * Single getter to pull status pages after expanding the range expression
- */
-Object.defineProperty(HttpExceptionHandler.prototype, 'expandedStatusPages', {
-    get() {
-        const value = Object.keys(this.statusPages).reduce((result, codeRange) => {
-            const parts = codeRange.split('.');
-            const min = Number(parts[0]);
-            const max = Number(parts[parts.length - 1]);
-            if (isNaN(min) || isNaN(max)) {
-                return result;
-            }
-            if (min === max) {
-                result[codeRange] = this.statusPages[codeRange];
-            }
-            Array.apply(null, new Array(max - min + 1)).forEach((_, step) => {
-                result[min + step] = this.statusPages[codeRange];
-            });
-            return result;
-        }, {});
-        Object.defineProperty(this, 'expandedStatusPages', { value });
-        return value;
-    },
-});

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

@@ -1,60 +0,0 @@
-/**
- * Exposes the API to execute app commands registered under
- * the manifest file.
- */
-export declare class App {
-    private appRoot;
-    private commandName;
-    /**
-     * Returns a boolean if mentioned command is an assembler
-     * command
-     */
-    private get isAssemblerCommand();
-    /**
-     * Reference to the app kernel
-     */
-    private kernel;
-    /**
-     * Reference to the ace kernel
-     */
-    private ace;
-    /**
-     * Source root always points to the compiled source
-     * code.
-     */
-    constructor(appRoot: string);
-    /**
-     * Print commands help
-     */
-    private printHelp;
-    /**
-     * Print framework version
-     */
-    private printVersion;
-    /**
-     * Invoked before command source will be read from the
-     * disk
-     */
-    private onFind;
-    /**
-     * Invoked before command is about to run.
-     */
-    private onRun;
-    /**
-     * Hooks into ace lifecycle events to conditionally
-     * load the app.
-     */
-    private registerAceHooks;
-    /**
-     * Adding flags
-     */
-    private registerAceFlags;
-    /**
-     * Load commands using manifest loader
-     */
-    loadCommands(): Promise<void>;
-    /**
-     * Handle application command
-     */
-    handle(argv: string[]): Promise<void>;
-}

package/build/src/Ignitor/Ace/App/index.js

@@ -1,236 +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.App = void 0;
-const ace_1 = require("@adonisjs/ace");
-const cliui_1 = require("@poppinss/cliui");
-const helpers_1 = require("@poppinss/utils/build/helpers");
-const Kernel_1 = require("../../Kernel");
-const utils_1 = require("../../../utils");
-const GenerateManifest_1 = require("../GenerateManifest");
-/**
- * A local list of assembler commands. We need this, so that when assembler
- * is not installed (probably in production) and someone is trying to
- * build the project by running `serve` or `build`, we should give
- * them a better descriptive error.
- *
- * Also, do note that at times this list will be stale, but we get it back
- * in sync over time.
- */
-const ASSEMBLER_COMMANDS = [
-    'build',
-    'serve',
-    'invoke',
-    'make:command',
-    'make:controller',
-    'make:exception',
-    'make:listener',
-    'make:middleware',
-    'make:prldfile',
-    'make:provider',
-    'make:validator',
-    'make:view',
-];
-/**
- * Exposes the API to execute app commands registered under
- * the manifest file.
- */
-class App {
-    /**
-     * Source root always points to the compiled source
-     * code.
-     */
-    constructor(appRoot) {
-        this.appRoot = appRoot;
-        /**
-         * Reference to the app kernel
-         */
-        this.kernel = new Kernel_1.AppKernel(this.appRoot, 'console');
-        /**
-         * Reference to the ace kernel
-         */
-        this.ace = new ace_1.Kernel(this.kernel.application);
-    }
-    /**
-     * Returns a boolean if mentioned command is an assembler
-     * command
-     */
-    get isAssemblerCommand() {
-        return ASSEMBLER_COMMANDS.includes(this.commandName);
-    }
-    /**
-     * Print commands help
-     */
-    printHelp(value, command) {
-        if (!value) {
-            return;
-        }
-        this.ace.printHelp(command, [GenerateManifest_1.GenerateManifest.getManifestJSON()]);
-        process.exit(0);
-    }
-    /**
-     * Print framework version
-     */
-    printVersion(value) {
-        if (!value) {
-            return;
-        }
-        const appVersion = this.kernel.application.version;
-        const adonisVersion = this.kernel.application.adonisVersion;
-        let assemblerVersion = 'Not Installed';
-        try {
-            assemblerVersion = require((0, helpers_1.resolveFrom)(this.appRoot, '@adonisjs/assembler/package.json')).version;
-        }
-        catch (error) { }
-        (0, cliui_1.sticker)()
-            .heading('node ace --version')
-            .add(`App version: ${cliui_1.logger.colors.cyan(appVersion ? appVersion.version : 'NA')}`)
-            .add(`Framework version: ${cliui_1.logger.colors.cyan(adonisVersion ? adonisVersion.version : 'NA')}`)
-            .add(`Assembler version: ${cliui_1.logger.colors.cyan(assemblerVersion)}`)
-            .render();
-        process.exit(0);
-    }
-    /**
-     * Invoked before command source will be read from the
-     * disk
-     */
-    async onFind(command) {
-        if (!command) {
-            return;
-        }
-        /**
-         * Register ts hook when
-         *
-         * - Haven't registered it already
-         * - Is a typescript project
-         * - Is not an assembler command
-         */
-        if (!this.isAssemblerCommand) {
-            this.kernel.registerTsCompilerHook();
-        }
-        /**
-         * Only main command can load the application or switch
-         * the environment.
-         *
-         * If a sub-command needs application, then the main command
-         * should set "loadApp" to true as well.
-         */
-        if (command.commandName === this.commandName || command.aliases.includes(this.commandName)) {
-            /**
-             * Switch environment before wiring the app
-             */
-            if (command.settings.environment) {
-                this.kernel.application.switchEnvironment(command.settings.environment);
-            }
-            if (command.settings.loadApp) {
-                /**
-                 * Set ace instance within the container, so that the underlying
-                 * commands or the app can access it from the container
-                 */
-                this.kernel.application.container.singleton('Adonis/Core/Ace', () => this.ace);
-                await this.kernel.boot();
-            }
-        }
-    }
-    /**
-     * Invoked before command is about to run.
-     */
-    async onRun() {
-        if (this.kernel.hasBooted) {
-            await this.kernel.start();
-        }
-    }
-    /**
-     * Hooks into ace lifecycle events to conditionally
-     * load the app.
-     */
-    registerAceHooks() {
-        this.ace.before('find', async (command) => this.onFind(command));
-        this.ace.before('run', async () => this.onRun());
-    }
-    /**
-     * Adding flags
-     */
-    registerAceFlags() {
-        /**
-         * Showing help including core commands
-         */
-        this.ace.flag('help', async (value, _, command) => this.printHelp(value, command), {
-            alias: 'h',
-        });
-        /**
-         * Showing app and AdonisJs version
-         */
-        this.ace.flag('version', async (value) => this.printVersion(value), { alias: 'v' });
-    }
-    /**
-     * Load commands using manifest loader
-     */
-    async loadCommands() {
-        await (0, utils_1.loadAceCommands)(this.kernel.application, this.ace);
-    }
-    /**
-     * Handle application command
-     */
-    async handle(argv) {
-        try {
-            /**
-             * Manifest files to load
-             */
-            await this.loadCommands();
-            /**
-             * Define ace hooks to wire the application (if required)
-             */
-            this.registerAceHooks();
-            /**
-             * Define global flags
-             */
-            this.registerAceFlags();
-            /**
-             * Print help when no arguments have been passed
-             */
-            if (!argv.length) {
-                this.printHelp(true);
-                return;
-            }
-            /**
-             * Hold reference to the command name. We will use this to decide whether
-             * or not to exit the process forcefully after the command has been
-             * executed
-             */
-            this.commandName = argv[0];
-            /**
-             * Listen for the exit signal on ace kernel
-             */
-            this.ace.onExit(async () => {
-                if (this.kernel.hasBooted) {
-                    await this.kernel.close();
-                }
-                if (!this.ace.error) {
-                    process.exit(this.ace.exitCode);
-                }
-                return this.kernel
-                    .handleError(this.ace.error)
-                    .finally(() => process.exit(this.ace.exitCode));
-            });
-            /**
-             * Handle command
-             */
-            await this.ace.handle(argv);
-        }
-        catch (error) {
-            if (!error) {
-                process.exit(1);
-            }
-            this.kernel.handleError(error).finally(() => process.exit(1));
-        }
-    }
-}
-exports.App = App;

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

@@ -1,4 +0,0 @@
-import { Exception } from '@poppinss/utils';
-export declare class AceRuntimeException extends Exception {
-    handle(error: AceRuntimeException): void;
-}

package/build/src/Ignitor/Ace/Exceptions/index.js

@@ -1,19 +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.AceRuntimeException = void 0;
-const cliui_1 = require("@poppinss/cliui");
-const utils_1 = require("@poppinss/utils");
-class AceRuntimeException extends utils_1.Exception {
-    handle(error) {
-        cliui_1.logger.error(error.message);
-    }
-}
-exports.AceRuntimeException = AceRuntimeException;

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

@@ -1,28 +0,0 @@
-/**
- * Exposes the API to generate the manifest file
- */
-export declare class GenerateManifest {
-    private appRoot;
-    private kernel;
-    /**
-     * Source root always points to the compiled source
-     * code.
-     */
-    constructor(appRoot: string);
-    /**
-     * Returns manifest object for showing help
-     */
-    static getManifestJSON(): {
-        commandName: string;
-        description: string;
-        args: never[];
-        flags: never[];
-        settings: {};
-        aliases: never[];
-        commandPath: string;
-    };
-    /**
-     * Generates the manifest file for commands
-     */
-    handle(): Promise<void>;
-}

package/build/src/Ignitor/Ace/GenerateManifest/index.js

@@ -1,75 +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.GenerateManifest = void 0;
-const cliui_1 = require("@poppinss/cliui");
-const ace_1 = require("@adonisjs/ace");
-const Kernel_1 = require("../../Kernel");
-const Exceptions_1 = require("../Exceptions");
-/**
- * Exposes the API to generate the manifest file
- */
-class GenerateManifest {
-    /**
-     * Source root always points to the compiled source
-     * code.
-     */
-    constructor(appRoot) {
-        this.appRoot = appRoot;
-        this.kernel = new Kernel_1.AppKernel(this.appRoot, 'console');
-    }
-    /**
-     * Returns manifest object for showing help
-     */
-    static getManifestJSON() {
-        return {
-            commandName: 'generate:manifest',
-            description: 'Generate ace commands manifest file. Manifest file speeds up commands lookup',
-            args: [],
-            flags: [],
-            settings: {},
-            aliases: [],
-            commandPath: '',
-        };
-    }
-    /**
-     * Generates the manifest file for commands
-     */
-    async handle() {
-        try {
-            this.kernel.registerTsCompilerHook();
-            const commands = this.kernel.application.rcFile.commands;
-            /**
-             * Generating manifest requires us to import the command files to read their
-             * meta data defined as class static properties. However, at this stage
-             * the application is not booted and hence top level IoC container
-             * imports will break
-             */
-            this.kernel.application.container.trap((namespace) => {
-                if (namespace === 'Adonis/Core/Application') {
-                    return this.kernel.application;
-                }
-                return {
-                    __esModule: new Proxy({ namespace }, {
-                        get(target) {
-                            throw new Exceptions_1.AceRuntimeException(`Top level import for module "${target.namespace}" is not allowed in commands. Learn more https://docs.adonisjs.com/guides/ace-commandline#top-level-imports-are-not-allowed`);
-                        },
-                    }),
-                };
-            });
-            await new ace_1.ManifestGenerator(this.appRoot, commands).generate();
-            cliui_1.logger.action('create').succeeded('ace-manifest.json file');
-        }
-        catch (error) {
-            await this.kernel.handleError(error).finally(() => process.exit(1));
-        }
-    }
-}
-exports.GenerateManifest = GenerateManifest;

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

@@ -1,11 +0,0 @@
-/**
- * Exposes the API to execute ace commands.
- */
-export declare class Ace {
-    private appRoot;
-    constructor(appRoot: string);
-    /**
-     * Handles the ace command
-     */
-    handle(argv: string[]): Promise<void>;
-}

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

@@ -1,36 +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.Ace = void 0;
-const App_1 = require("./App");
-const GenerateManifest_1 = require("./GenerateManifest");
-/**
- * Exposes the API to execute ace commands.
- */
-class Ace {
-    constructor(appRoot) {
-        this.appRoot = appRoot;
-    }
-    /**
-     * Handles the ace command
-     */
-    async handle(argv) {
-        process.env.ADONIS_ACE_CWD = this.appRoot;
-        if (argv[0] === 'generate:manifest' && !argv.includes('--help')) {
-            await new GenerateManifest_1.GenerateManifest(this.appRoot).handle();
-            return;
-        }
-        /**
-         * Proxy over to application commands
-         */
-        await new App_1.App(this.appRoot).handle(argv);
-    }
-}
-exports.Ace = Ace;