Function createApp

packages/core/src/express/create-app.ts:90–203

(
  AppController: Class<IAppController>,
  options: CreateAppOptions = {},
)

 * @returns {Promise<any>} The express application.
 */
export async function createApp(
  AppController: Class<IAppController>,
  options: CreateAppOptions = {},
): Promise<any> {
  const app = options.expressInstance || express();

  // Add optional pre-middlewares.
  for (const middleware of options.preMiddlewares || []) {
    app.use(middleware);
  }

  // Create the service and controller manager.
  const services = options.serviceManager || new ServiceManager();
  app.foal = { services };

  // Retrieve the logger.
  const logger = services.get(Logger);

  // Allow to add log context.
  app.use((req: any, res: any, next: (err?: any) => any) => {
    logger.initLogContext(next);
  });

  // Generate a unique ID for each request.
  app.use((req: any, res: any, next: (err?: any) => any) => {
    const requestId = req.get('x-request-id') || randomUUID();

    req.id = requestId;
    logger.addLogContext({ requestId });

    next();
  });

  // Log requests.
  const shouldLogHttpRequests = Config.get('settings.logger.logHttpRequests', 'boolean', true);
  if (shouldLogHttpRequests) {
    const getHttpLogParams = options.getHttpLogParams || getHttpLogParamsDefault;
    app.use(morgan(
      (tokens: any, req: any, res: any) => JSON.stringify(getHttpLogParams(tokens, req, res)),
      {
        stream: {
          write: (message: string) => {
            const data = JSON.parse(message);
            logger.info(`${httpRequestMessagePrefix}${data.method} ${data.url}`, data);
          },
        },
      }
    ))
  }

  app.use(protectionHeaders);

  // Serve static files.
  app.use(
    Config.get('settings.staticPathPrefix', 'string', ''),
    express.static(Config.get('settings.staticPath', 'string', 'public'), {
      cacheControl: Config.get('settings.staticFiles.cacheControl', 'boolean')
    })