actionhero/src/config/web.ts

The reusable, scalable, and quick node.js API server for stateless and stateful applications

import * as os from "os";
import { ActionheroConfigInterface } from "..";

import type { Options as FormParserOptions } from "formidable";

const namespace = "web";

declare module ".." {
  export interface ActionheroConfigInterface {
    [namespace]: ReturnType<(typeof DEFAULT)[typeof namespace]>;
  }
}

export const DEFAULT = {
  [namespace]: (config: ActionheroConfigInterface) => {
    return {
      enabled: true,
      // HTTP or HTTPS?  This setting is to enable SSL termination directly in the actionhero app, not set redirection host headers
      secure: false,
      // Passed to https.createServer if secure=true. Should contain SSL certificates
      serverOptions: {},
      // Should we redirect all traffic to the first host in this array if hte request header doesn't match?
      // i.e.: [ 'https://www.site.com' ]
      allowedRequestHosts: process.env.ALLOWED_HOSTS
        ? process.env.ALLOWED_HOSTS.split(",")
        : [],
      // Port or Socket Path
      port: process.env.PORT || 8080,
      // Which IP to listen on (use '0.0.0.0' for the default ip stack; '::' for all on ipv4 and ipv6)
      // Set to `null` when listening to socket
      bindIP: "::",
      // Any additional headers you want actionhero to respond with
      httpHeaders: {
        "X-Powered-By": config.general.serverName,
        "Access-Control-Allow-Origin": "*",
        "Access-Control-Allow-Methods":
          "HEAD, GET, POST, PUT, PATCH, DELETE, OPTIONS, TRACE",
        "Access-Control-Allow-Headers": "Content-Type",
        "Strict-Transport-Security": "max-age=31536000; includeSubDomains",
      },
      // Route that actions will be served from; secondary route against this route will be treated as actions,
      //  IE: /api/?action=test == /api/test/
      urlPathForActions: "api",
      // Route that static files will be served from;
      //  path (relative to your project root) to serve static content from
      //  set to `null` to disable the file server entirely
      urlPathForFiles: "public",
      // When visiting the root URL, should visitors see 'api' or 'file'?
      //  Visitors can always visit /api and /public as normal
      rootEndpointType: "file",
      // In addition to what's defined in config/routes.ts, should we make a route for every action?  Useful for debugging or simple APIs.
      // automaticRoutes should an array of strings - HTTP verbs, ie: [] (default), ['get'], ['post'], ['get','put'], ['get','post','put'], etc.
      automaticRoutes: process.env.AUTOMATIC_ROUTES
        ? process.env.AUTOMATIC_ROUTES.split(",")
            .map((v) => v.trim())
            .map((v) => v.toLowerCase())
        : [],
      // Default HTTP status code for errors thrown in an action
      defaultErrorStatusCode: 500,
      // The cache or (if etags are enabled) next-revalidation time to be returned for all flat files served from /public; defined in seconds
      flatFileCacheDuration: 60,
      // Add an etag header to requested flat files which acts as fingerprint that changes when the file is updated;
      // Client will revalidate the fingerprint at latest after flatFileCacheDuration and reload it if the etag (and therefore the file) changed
      // or continue to use the cached file if it's still valid
      enableEtag: true,
      // should we save the un-parsed HTTP POST/PUT payload to connection.rawConnection.params.rawBody?
      saveRawBody: false,
      // How many times should we try to boot the server?
      // This might happen if the port is in use by another process or the socket file is claimed
      bootAttempts: 1,
      // Settings for determining the id of an http(s) request (browser-fingerprint)
      fingerprintOptions: {
        cookieKey: "sessionID",
        toSetCookie: true,
        onlyStaticElements: false,
        settings: {
          path: "/",
          expires: 3600000,
        },
      },
      // Options to be applied to incoming file uploads.
      //  More options and details at https://github.com/felixge/node-formidable
      formOptions: {
        multiples: false, // enabling will allow for multiple values to be sent for a single key, e.g. array values, but will transform most POST/PUT payloads to arrays
        uploadDir: os.tmpdir(),
        keepExtensions: false,
        maxFieldsSize: 1024 * 1024 * 20,
        maxFileSize: 1024 * 1024 * 200,
      } as FormParserOptions,
      // Should we pad JSON responses with whitespace to make them more human-readable?
      // set to null to disable
      padding: 2,
      // Options to configure metadata in responses
      metadataOptions: {
        serverInformation: true,
        requesterInformation: true,
      },
      // When true, returnErrorCodes will modify the response header for http(s) clients if connection.error is not null.
      // You can also set connection.rawConnection.responseHttpCode to specify a code per request.
      returnErrorCodes: true,
      // should this node server attempt to gzip responses if the client can accept them?
      // this will slow down the performance of actionhero, and if you need this functionality, it is recommended that you do this upstream with nginx or your load balancer
      compress: false,
      // options to pass to the query parser
      // learn more about the options @ https://github.com/hapijs/qs
      queryParseOptions: {},
    };
  },
};

export const production = {
  [namespace]: () => {
    return {
      padding: null as number,
      metadataOptions: {
        serverInformation: false,
        requesterInformation: false,
      },
    };
  },
};

export const test = {
  [namespace]: () => {
    return {
      secure: false,
      port: process.env.PORT
        ? process.env.PORT
        : 18080 + parseInt(process.env.JEST_WORKER_ID || "0"),
      matchExtensionMime: true,
      metadataOptions: {
        serverInformation: true,
        requesterInformation: true,
      },
    };
  },
};