application-services/dist/services/ENV.js

Out of the box application environment and configuration service.

import { readFile as _readFile } from 'node:fs/promises';
import path from 'node:path';
import { parse as parseDotEnv } from 'dotenv';
import { autoService, name, singleton, location, } from 'knifecycle';
import { noop } from 'common-services';
import { YError, printStackTrace } from 'yerror';
export var NodeEnv;
(function (NodeEnv) {
    NodeEnv["Test"] = "test";
    NodeEnv["Development"] = "development";
    NodeEnv["Production"] = "production";
})(NodeEnv || (NodeEnv = {}));
const DEFAULT_BASE_ENV = {};
const NODE_ENVS = Object.values(NodeEnv);
/**
 * Initialize the ENV service using process env plus dotenv files
 *  loaded in `.env.node.${ENV.NODE_ENV}` and `.env.app.${APP_ENV}`.
 * @param  {Object}   services
 * The services `ENV` depends on
 * @param  {Object}   [services.BASE_ENV]
 * Base env vars that will be added to the environment
 * @param  {Object}   services.APP_ENV
 * The injected `APP_ENV` value
 * @param  {Object}   services.PROCESS_ENV
 * The injected `process.env` value
 * @param  {Object}   services.PROJECT_DIR
 * The NodeJS project directory
 * @param  {Object}   [services.log=noop]
 * An optional logging service
 * @return {Promise<Object>}
 * A promise of an object containing the actual env vars.
 */
async function initENV({ BASE_ENV = DEFAULT_BASE_ENV, APP_ENV, PROCESS_ENV, PROJECT_DIR, log = noop, readFile = _readFile, }) {
    let ENV = BASE_ENV.NODE_ENV
        ? {
            NODE_ENV: BASE_ENV.NODE_ENV,
        }
        : {};
    log('debug', `♻️ - Loading the environment service.`);
    log('warning', `🔴 - Running with "${APP_ENV}" application environment.`);
    /* Architecture Note #1.3.1: Environment isolation
    Per default, we take the process environment as is
     but since it could lead to leaks when building
     projects statically so one can isolate the process
     env by using the `ISOLATED_ENV` environment variable.
    */
    if (!PROCESS_ENV.ISOLATED_ENV) {
        ENV = { ...ENV, ...PROCESS_ENV };
        log('debug', `🖥 - Using the process env.`);
    }
    else {
        log('warning', `🖥 - Using an isolated env.`);
    }
    if (!ENV.NODE_ENV) {
        log('warning', `⚠ - NODE_ENV environment variable is not set, setting it to "${NodeEnv.Development}".`);
        ENV.NODE_ENV = NodeEnv.Development;
    }
    if (!NODE_ENVS.includes(ENV.NODE_ENV)) {
        log('error', `❌ - Non-standard NODE_ENV value detected: "${ENV.NODE_ENV}".`);
        throw new YError('E_BAD_NODE_ENV', [ENV.NODE_ENV, NODE_ENVS]);
    }
    const FINAL_NODE_ENV = ENV.NODE_ENV;
    log('warning', `🔂 - Running with "${FINAL_NODE_ENV}" node environment.`);
    /* Architecture Note #1.3.2: `.env.node.${NODE_ENV}` files
  
    You may want to set some env vars depending on the
     `NODE_ENV`. We use `dotenv` to provide your such
     ability.
    */
    const nodeEnvFile = `.env.node.${ENV.NODE_ENV}`;
    /* Architecture Note #1.3.3: `.env.app.${APP_ENV}` files
    You may need to keep some secrets out of your Git
     history fo each deployment targets too.
    */
    const appEnvFile = `.env.app.${APP_ENV}`;
    /* Architecture Note #1.3.4: evaluation order
    The final environment is composed from the different sources
     in this order:
    - the `.env.node.${NODE_ENV}` file content if exists
    - the `.env.app.${APP_ENV}` file content if exists
    - the process ENV (so that one can override values by
       adding environment variables).
    */
    ENV = (await Promise.all([
        BASE_ENV,
        _readEnvFile({ PROJECT_DIR, readFile, log }, nodeEnvFile),
        _readEnvFile({ PROJECT_DIR, readFile, log }, appEnvFile),
        ENV,
    ])).reduce((ENV, A_ENV) => ({ ...ENV, ...A_ENV }), {});
    if (ENV.NODE_ENV !== FINAL_NODE_ENV) {
        log('error', `❌ - Illegal attempt to change the NODE_ENV value via env files: "${ENV.NODE_ENV}".`);
        throw new YError('E_BAD_ENV', [ENV.NODE_ENV, FINAL_NODE_ENV]);
    }
    return ENV;
}
async function _readEnvFile({ PROJECT_DIR, readFile, log, }, filePath) {
    const fullFilePath = path.join(PROJECT_DIR, filePath);
    log('debug', `💾 - Trying to load .env file at "${fullFilePath}".`);
    try {
        const buf = await readFile(fullFilePath);
        const FILE_ENV = parseDotEnv(buf);
        log('warning', `🖬 - Loaded .env file at "${fullFilePath}".`);
        return FILE_ENV;
    }
    catch (err) {
        log('debug', `🚫 - No file found at "${fullFilePath}".`);
        log('debug-stack', printStackTrace(err));
        return {};
    }
}
export default location(singleton(name('ENV', autoService(initENV))), import.meta.url);
//# sourceMappingURL=ENV.js.map