env

The env module is used to retrieve global application environment variables in runtime and pass these parameters to the client. With a pre-defined list of variables used by the application, dynamically extended and validated at application startup

Installation

Already supplied inside @tramvai/module-common and does not need to be installed if module-common is connected.

Otherwise, you need to install @tramvai/module-environment

Explanation

Dynamically generated list of used env variables

All the parameters used in the application are registered by implementing the ENV_USED_TOKEN token in the DI and it is assumed that each module individually registers only the env parameters it needs. In this case, when a module is connected, there will be automatic validation of all passed parameters that are necessary for the application to work

import { provide } from '@tramvai/core';

@Module({
  providers: [
    provide({
      provide: ENV_USED_TOKEN,
      useValue: [
        { key: 'DEBUG_MODULE' },
        { key: 'DEBUG_MODULE_URL' },
      ],
      multi: true,
    }),
  ],
})
export class MyModule {}

In the above example, the module registers several env tokens, which will be initialized and will be available in environmentManager.get('DEBUG_MODULE'). In doing so, the optional parameter has been passed, which indicates that the variables are not required for the application to work.

Validation of environment variables values

When the application starts, it checks the tokens that were registered in the DI and passed to env at startup. If all required env variables have not been passed to the application, the application will crash.

It is also possible to write validators for env values, which will run when the application is initialized.

import { provide } from '@tramvai/core';

@Module({
  providers: [
    provide({
      provide: ENV_USED_TOKEN,
      useValue: [
        {
          key: 'MY_ENV',
          validator: (env) => {
            if (!env.includes('https')) {
              return 'Incorrect link format. The link should contain https';
            }
          },
        },
      ],
      multi: true,
    }),
  ],
})
export class MyModule {}

Functionality works on the server and in the browser

All env variables will be available both on the server and in the browser without any additional actions or settings. Env variables that have dehydrate: true are automatically passed to the browser

Priority of obtaining values for env variables

Since it is possible to overwrite the values of the variables, the variables are replaced according to certain rules

The replacement rules are arranged in order of priority, from lower to higher:

• Parameters set in tokens { key: 'ENV_PARAM', value: 'env value' }
• Parameters written in env.development.js file
• Passing application launch parameters MY_ENV=j node server.js

API

Exported tokens and TS interface

import { Scope, createToken } from '@tinkoff/dippy';

export interface EnvironmentManager {
  get(name: string): string | undefined;
  getInt(name: string, def: number): number;
  getAll(): Record<string, string | undefined>;
  update(result: Record<string, string>): void;
  /**
   * @deprecated use CLIENT_ENV_MANAGER_TOKEN
   */
  clientUsed(): Record<string, string | undefined>;
  /**
   * @deprecated use CLIENT_ENV_MANAGER_TOKEN
   */
  updateClientUsed(result: Record<string, string>): void;
}

export interface ClientEnvironmentRepository {
  get(name: string): string | undefined;
  set(name: string, value: string): void;
  getAll(): Record<string, string | undefined>;
  update(result: Record<string, string>): void;
}

/**
 * @description
 * Instance that used for managing environment variables
 */
export const ENV_MANAGER_TOKEN = createToken<EnvironmentManager>('environmentManager', {
  scope: Scope.SINGLETON,
});

/**
 * @description
 * Instance that used for store and manage environment variables map, which are passed to the client.
 * Use only server-side for client env values modification depending on the specific request conditions.
 */
export const CLIENT_ENV_REPOSITORY_TOKEN = createToken<ClientEnvironmentRepository>(
  'clientEnvironmentManager',
  {
    scope: Scope.REQUEST,
  }
);

/**
 * @description
 * List of envs that are used by the module or the app.
 * All of the envs specified by that token will be accessible in the code through `environmentManager`
 * ENV_USED_TOKEN format:
    - `key` - id of the env. At that id the value of the env will be accessible through `environmentManager` and will be loaded from the external sources.
    - `value` - default low-priority value for env `key`
    - `optional` - is current env is optional. If `true` the app can work as usual event if the env value were not provided, if `false` - the app will fail to run without env value
    - `validator` - validation function for passed env value. In case this function returns string it will be used as error message and validation will fail
    - `dehydrate` - if `false` then env value will not be passed to client and this env can be used only on server
 *
 * @example
  ```tsx
  interface EnvParameter {
    key: string;
    value?: string;
    optional?: boolean;
    validator?: (value: string) => boolean | string;
    dehydrate?: boolean;
  }
  ```
 */
export interface EnvParameter {
  key: string;
  value?: string;
  optional?: boolean;
  validator?: (value: string) => boolean | string;
  dehydrate?: boolean;
}

export const ENV_USED_TOKEN = createToken<EnvParameter[]>('envUsed', { multi: true });

export type EnvTemplate = {
  key: string;
  fn: (...args: any[]) => string;
};

export const ENV_TEMPLATE_TOKEN = createToken<EnvTemplate>('env template token', {
  multi: true,
  scope: Scope.SINGLETON,
});

How to

How to read data in an application

Suppose we registered the parameter CONFIG_API used by env with the ENV_USED_TOKEN token, now we need to connect environmentManager in the application and read the data:

import { provide } from '@tramvai/core';

@Module({
  providers: [
    provide({
      provide: 'MY_SERVICE',
      useClass: class MyService {
        constructor({ environmentManager }) {
          console.log(environmentManager.get('CONFIG_API'));
        }
      },
      deps: {
        environmentManager: ENV_MANAGER_TOKEN,
      },
    }),
  ],
})
export class MyModule {}

This code will work both on the server and in the browser

How you can simply pass parameters in local development

To do this, create a file env.development.js in the root of the project and write all env variables for the application. When the application is initialized, this file will be read.

Peculiarities of using env.developmen.js in production builds

The twelve factors application stores the configuration in environment variables, so by default when process.env.NODE_ENV === 'production' EnvironmentManger will not read the env.development.js file.

If you want to test the application locally with NODE_ENV=production, you can pass the flag DANGEROUS_UNSAFE_ENV_FILES='true' so that EnvironmentManger will read the env.development.js file and not have to enter all variables by hand.

How to pass env parameters to the application during the deploys

To do this, pass env parameters when starting the application. For example in Docker you can do this with the parameter -e docker run -e MY_ENV_VAR=/ my-image.

How to view all env variables of an application

This method allows you to see only client variables

To get a list of variables, there is a /papi/apiList method

Request example: http://localhost:3000/${appName}/papi/apiList

How to make an ENV variable optional?

To do this, pass optional: true parameter. For example { key: 'DEBUG_MODULE', optional: true }