stdlib: cache environment variables (#454)

Removes the 'log' export from 'insight'.

Accessing process.env.XXX is relatively slow in Node.js.
Benchmark of a plain object property access and accessing process.env.NODE_ENV:

```
property access       500000000  iterations     0  ns/op
process.env access      5000000  iterations   246  ns/op
```

See this thread nodejs/node#3104 for some more context

docs/getting-started.md

@@ -43,7 +43,6 @@ Let's start with the imports:
 
 ```javascript
 import { App, generators, loadFromRemote } from "@lbu/code-gen";
-import { log } from "@lbu/insight";
 import { mainFn } from "@lbu/stdlib";
 ```
 

packages/cli/scripts/lint.js

@@ -1,4 +1,4 @@
-import { mainFn, spawn } from "@lbu/stdlib";
+import { mainFn, spawn, environment } from "@lbu/stdlib";
 
 mainFn(import.meta, async () => {
   const { exitCode: lint } = await spawn("./node_modules/.bin/eslint", [
@@ -9,7 +9,7 @@ mainFn(import.meta, async () => {
   ]);
 
   const prettierCommand =
-    process.env.CI === "true" ? ["--check"] : ["--write", "--list-different"];
+    environment.CI === "true" ? ["--check"] : ["--write", "--list-different"];
 
   const { exitCode: pretty } = await spawn("./node_modules/.bin/prettier", [
     ...prettierCommand,

packages/cli/src/benchmarking/printer.js

@@ -1,6 +1,6 @@
 import { writeFileSync } from "fs";
 import { inspect } from "util";
-import { AppError, isNil, pathJoin } from "@lbu/stdlib";
+import { AppError, environment, isNil, pathJoin } from "@lbu/stdlib";
 import { benchLogger, state } from "./state.js";
 
 export function printBenchResults() {
@@ -40,7 +40,7 @@ export function printBenchResults() {
 
   logFn(result.join("\n"));
 
-  if (process.env.CI === "true") {
+  if (environment.CI === "true") {
     // Write output to a file so it can be used in other actions
     // Add some point we may want to do some pretty printing to format as a table or
     // something

packages/cli/src/commands/docker.js

@@ -1,4 +1,4 @@
-import { exec, spawn } from "@lbu/stdlib";
+import { environment, exec, spawn } from "@lbu/stdlib";
 
 const SUB_COMMANDS = ["up", "down", "clean", "reset"];
 
@@ -200,7 +200,7 @@ async function resetDatabase(logger, containerInfo) {
     return startExitCode;
   }
 
-  const name = process.env.APP_NAME;
+  const name = environment.APP_NAME;
 
   logger.info(`Resetting ${name} database`);
   const { exitCode: postgresExit } = await spawn(`sh`, [
@@ -253,5 +253,5 @@ async function getKnownContainers() {
 }
 
 function getPostgresVersion() {
-  return Number(process.env.POSTGRES_VERSION ?? "12");
+  return Number(environment.POSTGRES_VERSION ?? "12");
 }

packages/cli/src/commands/proxy.js

@@ -1,5 +1,5 @@
 import { createServer } from "http";
-import { isNil } from "@lbu/stdlib";
+import { environment, isNil } from "@lbu/stdlib";
 import proxy from "http-proxy";
 
 /**
@@ -8,7 +8,7 @@ import proxy from "http-proxy";
  */
 export async function proxyCommand(logger) {
   const port = parseInt(
-    (process.env.API_URL ?? process.env.NEXT_PUBLIC_API_URL ?? "")
+    (environment.API_URL ?? environment.NEXT_PUBLIC_API_URL ?? "")
       .split(":")
       .pop(),
   );
@@ -19,7 +19,7 @@ export async function proxyCommand(logger) {
     );
     process.exit(1);
   }
-  if ((process.env.PROXY_URL ?? "").length === 0) {
+  if ((environment.PROXY_URL ?? "").length === 0) {
     logger.error("Please set the `PROXY_URL` environment variable");
     process.exit(1);
   }
@@ -39,7 +39,7 @@ export async function proxyCommand(logger) {
 
   const allowMethods = "GET,PUT,POST,PATCH,DELETE,HEAD,OPTIONS";
   const options = {
-    target: process.env.PROXY_URL,
+    target: environment.PROXY_URL,
     changeOrigin: true,
     cookieDomainRewrite: "",
   };

packages/cli/template/scripts/api.js

@@ -1,4 +1,4 @@
-import { mainFn, isProduction, isStaging } from "@lbu/stdlib";
+import { mainFn, isProduction, isStaging, environment } from "@lbu/stdlib";
 import { constructApp } from "../src/api.js";
 import { injectServices } from "../src/service.js";
 import { app } from "../src/services/index.js";
@@ -12,7 +12,7 @@ async function main(logger) {
   await injectServices();
   await constructApp();
 
-  const port = process.env.PORT || 3000;
+  const port = environment.PORT || 3000;
   app.listen(port, () => {
     logger.info({
       msg: "Listening",

packages/cli/template/src/service.js

@@ -1,6 +1,6 @@
 import { newLogger } from "@lbu/insight";
 import { createBodyParsers, session } from "@lbu/server";
-import { isStaging } from "@lbu/stdlib";
+import { environment, isStaging } from "@lbu/stdlib";
 import {
   FileCache,
   newMinioClient,
@@ -40,7 +40,7 @@ export async function injectServices() {
       createIfNotExists: isStaging(),
     }),
   );
-  setAppBucket(process.env.APP_NAME);
+  setAppBucket(environment.APP_NAME);
   setMinio(newMinioClient({}));
   setSessionStore(newSessionStore(sql));
   setFileCache(new FileCache(sql, minio, appBucket));

packages/code-gen/src/open-api-importer.js

@@ -1,4 +1,4 @@
-import { log } from "@lbu/insight";
+import { newLogger } from "@lbu/insight";
 import { isNil } from "@lbu/stdlib";
 import {
   AnyOfType,
@@ -45,6 +45,7 @@ export function convertOpenAPISpec(defaultGroup, data) {
    * openAPIReferences to resolve $ref's in the document
    */
   const context = {
+    logger: newLogger(),
     result,
     defaultGroup: lowerCaseFirst(defaultGroup),
     data,
@@ -399,7 +400,7 @@ function convertSchema(context, schema) {
       result.values = convertSchema(context, schema.additionalProperties);
 
       if (!isNil(schema.minProperties) || !isNil(schema.maxProperties)) {
-        log.info(
+        context.logger.info(
           "object#minProperties and object#maxProperties are not supported",
         );
       }
@@ -451,7 +452,7 @@ function convertSchema(context, schema) {
       result.validator.max = schema.maximum;
     }
     if (!isNil(schema.exclusiveMinimum) || !isNil(schema.exclusiveMaximum)) {
-      log.info(
+      context.logger.info(
         "number#exclusiveMinimum and number#exclusiveMaximum are not supported",
       );
     }
@@ -480,7 +481,9 @@ function convertSchema(context, schema) {
     assignBaseData();
 
     if (!schema.$ref.startsWith("#/")) {
-      log.info(`Only local references supported. Found ${schema.$ref}`);
+      context.logger.info(
+        `Only local references supported. Found ${schema.$ref}`,
+      );
     } else {
       result.reference = {
         group: context.defaultGroup,

packages/insight/index.d.ts

@@ -70,11 +70,6 @@ export function bytesToHumanReadable(bytes?: number): string;
  */
 export function printProcessMemoryUsage(logger: Logger): void;
 
-/**
- * Standard log instance
- */
-export const log: Logger;
-
 /**
  * Basic timing and call information
  */

packages/insight/index.js

@@ -1,7 +1,6 @@
-import { newLogger } from "./src/logger/logger.js";
+export { newLogger } from "./src/logger/logger.js";
 
 export { bytesToHumanReadable, printProcessMemoryUsage } from "./src/memory.js";
-export { newLogger } from "./src/logger/logger.js";
 
 export {
   newEvent,
@@ -11,9 +10,5 @@ export {
   newTestEvent,
   newEventFromEvent,
 } from "./src/events.js";
-export { postgresTableSizes } from "./src/postgres.js";
 
-/**
- * @type {Logger}
- */
-export const log = newLogger({});
+export { postgresTableSizes } from "./src/postgres.js";

packages/insight/package.json

@@ -12,6 +12,9 @@
     "logger"
   ],
   "license": "MIT",
+  "dependencies": {
+    "@lbu/stdlib": "0.0.91"
+  },
   "maintainers": [
     {
       "name": "Dirk de Visser",

packages/insight/src/logger/logger.js

@@ -1,13 +1,14 @@
+import { environment } from "@lbu/stdlib";
 import { writeNDJSON, writePretty } from "./writer.js";
 
 /**
  * @param {LoggerOptions} [options]
  * @returns {Logger}
  */
 export function newLogger(options) {
-  const app = process.env.APP_NAME;
+  const app = environment.APP_NAME;
   const isProduction =
-    options?.pretty === false || process.env.NODE_ENV === "production";
+    options?.pretty === false || environment.NODE_ENV === "production";
   const stream = options?.stream ?? process.stdout;
 
   const logFn = isProduction

packages/server/src/middleware/cors.js

@@ -1,4 +1,4 @@
-import { isStaging } from "@lbu/stdlib";
+import { environment, isStaging } from "@lbu/stdlib";
 
 /*
  Original copy from: https://github.com/zadzbw/koa2-cors/commit/45b6de0de6c4816b93d49335490b81995d450191
@@ -62,11 +62,11 @@ export function cors(options = {}) {
   if (typeof options.origin === "function") {
     originFn = options.origin;
   } else if (
-    process.env.CORS_URL !== undefined &&
-    process.env.CORS_URL.length > 0
+    environment.CORS_URL !== undefined &&
+    environment.CORS_URL.length > 0
   ) {
     // Use CORS_URL array provided via environment variables
-    const allowedOrigins = (process.env.CORS_URL || "").split(",");
+    const allowedOrigins = (environment.CORS_URL || "").split(",");
     const localhostRegex = /^http:\/\/localhost:\d{1,6}$/gi;
 
     if (isStaging()) {

packages/server/src/middleware/session.js

@@ -1,4 +1,4 @@
-import { isNil, isProduction, merge, uuid } from "@lbu/stdlib";
+import { environment, isNil, isProduction, merge, uuid } from "@lbu/stdlib";
 import KeyGrip from "keygrip";
 import koaSession from "koa-session";
 
@@ -17,11 +17,11 @@ export function session(app, opts) {
   const options = merge(
     {},
     {
-      key: `${process.env.APP_NAME.toLowerCase()}.sess`,
+      key: `${environment.APP_NAME.toLowerCase()}.sess`,
       maxAge: 6 * 24 * 60 * 60 * 1000,
       renew: true,
       secure: isProduction(),
-      domain: !isProduction() ? undefined : process.env.COOKIE_URL,
+      domain: !isProduction() ? undefined : environment.COOKIE_URL,
       sameSite: "lax",
       overwrite: true,
       httpOnly: true,
@@ -44,14 +44,14 @@ export function session(app, opts) {
  */
 function getKeys() {
   if (!isProduction()) {
-    return [process.env.APP_NAME];
+    return [environment.APP_NAME];
   }
 
-  if (isNil(process.env.APP_KEYS) || process.env.APP_KEYS.length < 20) {
+  if (isNil(environment.APP_KEYS) || environment.APP_KEYS.length < 20) {
     throw new Error("Missing APP_KEYS in environment or generate a longer key");
   }
 
-  const keys = process.env.APP_KEYS.split(",");
+  const keys = environment.APP_KEYS.split(",");
   return new KeyGrip(keys, "sha256");
 }
 

packages/stdlib/index.d.ts

@@ -309,6 +309,27 @@ export function filenameForModule(meta: ImportMeta): string;
  */
 export function dirnameForModule(meta: ImportMeta): string;
 
+/**
+ * Cached environment, set by `refreshEnvironmentCache()`
+ */
+export const environment: typeof process.env;
+
+/**
+ * Repopulate the cached environment copy.
+ * This should only be necessary when you or a sub package mutates the environment.
+ * The `mainFn` / `mainTestFn` / `mainBenchFn` / ... will call this function by default
+ * after loading your `.env` file.
+ *
+ * Accessing process.env.XXX is relatively slow in Node.js.
+ * Benchmark of a plain object property access and accessing process.env.NODE_ENV:
+ *
+ * property access       500000000  iterations     0  ns/op
+ * process.env access      5000000  iterations   246  ns/op
+ *
+ * See this thread: https://github.com/nodejs/node/issues/3104
+ */
+export function refreshEnvironmentCache(): void;
+
 /**
  * Returns whether NODE_ENV === "production"
  */

packages/stdlib/index.js

@@ -1,5 +1,14 @@
 export { uuid } from "./src/datatypes.js";
+
 export { AppError } from "./src/error.js";
+
+export {
+  isProduction,
+  isStaging,
+  environment,
+  refreshEnvironmentCache,
+} from "./src/env.js";
+
 export {
   isNil,
   isPlainObject,
@@ -8,6 +17,7 @@ export {
   unFlatten,
   camelToSnakeCase,
 } from "./src/lodash.js";
+
 export {
   exec,
   spawn,
@@ -16,13 +26,12 @@ export {
   processDirectoryRecursive,
   processDirectoryRecursiveSync,
 } from "./src/node.js";
+
 export {
   getSecondsSinceEpoch,
   gc,
   mainFn,
   noop,
   filenameForModule,
   dirnameForModule,
-  isProduction,
-  isStaging,
 } from "./src/utils.js";

packages/stdlib/src/env.js

@@ -0,0 +1,38 @@
+/**
+ * Cached process.env
+ */
+export let environment = {};
+
+/**
+ * Repopulate the cached environment copy.
+ * This should only be necessary when you or a sub package mutates the environment.
+ * The `mainFn` / `mainTestFn` / `mainBenchFn` / ... will call this function by default
+ * after loading your `.env` file.
+ *
+ * Accessing process.env.XXX is relatively in Node.js.
+ * Benchmark of a plain object property access and accessing process.env.NODE_ENV:
+ *
+ * property access       500000000  iterations     0  ns/op
+ * process.env access      5000000  iterations   246  ns/op
+ *
+ * See this thread: https://github.com/nodejs/node/issues/3104
+ */
+export function refreshEnvironmentCache() {
+  environment = JSON.parse(JSON.stringify(process.env));
+}
+
+/**
+ * @returns {boolean}
+ */
+export function isProduction() {
+  return environment.NODE_ENV === "production";
+}
+
+/**
+ * @returns {boolean}
+ */
+export function isStaging() {
+  return (
+    environment.NODE_ENV !== "production" || environment.IS_STAGING === "true"
+  );
+}