@platformatic/foundation 3.64.0 → 3.66.0

package/index.d.ts

@@ -6,6 +6,7 @@ import { LevelWithSilentOrString, Logger } from 'pino'
 
 // Symbols
 export declare const kCanceled: unique symbol
+export declare const kEnvFileFallbackKeys: unique symbol
 export declare const kFailedImport: unique symbol
 export declare const kHandledError: unique symbol
 export declare const kMetadata: unique symbol

package/lib/configuration.js

@@ -18,7 +18,7 @@ import {
 } from './errors.js'
 import { isFileAccessible } from './file-system.js'
 import { loadModule, splitModuleFromVersion } from './module.js'
-import { kMetadata } from './symbols.js'
+import { kEnvFileFallbackKeys, kMetadata } from './symbols.js'
 
 const { parse: parseJSON5, stringify: rawStringifyJSON5 } = JSON5
 const { parse: parseTOML, stringify: stringifyTOML } = toml
@@ -386,11 +386,21 @@ export async function loadEnv (root, ignoreProcessEnv = false, additionalEnv = {
   // The env file provides fallback defaults: variables already set in the real
   // environment (and explicit programmatic values) take precedence over it,
   // matching the dotenv/docker-compose/Vite convention.
-  return {
+  const env = {
     ...envFromFile,
     ...baseEnv,
     ...additionalEnv
   }
+
+  // Keys whose only source is the env file are not real environment variables, they are defaults:
+  // a more specific env file, like the one of a single application inside a runtime, must still be
+  // able to override them. The list is attached non enumerably, so spreading, Object.keys,
+  // JSON.stringify and structuredClone of the returned environment are all unchanged.
+  const fallbackKeys = Object.keys(envFromFile).filter(key => !(key in baseEnv) && !(key in additionalEnv))
+
+  Object.defineProperty(env, kEnvFileFallbackKeys, { value: fallbackKeys, enumerable: false })
+
+  return env
 }
 
 export function replaceEnv (config, env, onMissingEnv, ignore) {
@@ -503,6 +513,7 @@ export async function loadConfiguration (source, schema, options = {}) {
 
   if (shouldReplaceEnv) {
     const missingEnv = new Set()
+    const fallbackEnv = new Set()
 
     config = replaceEnv(
       config,
@@ -512,6 +523,11 @@ export async function loadConfiguration (source, schema, options = {}) {
 
         if (typeof value === 'undefined' || value === null) {
           missingEnv.add(key)
+        } else {
+          // The variable is not set: it only has a value because onMissingEnv provided a fallback.
+          // Track it separately so that strictEnv can still report it, as a fallback can silently
+          // mask a misconfiguration.
+          fallbackEnv.add(key)
         }
 
         return value
@@ -523,17 +539,31 @@ export async function loadConfiguration (source, schema, options = {}) {
     // (runtime configurations) or in the runtime property (capabilities configurations).
     const strictEnv = normalizeStrictEnv(strictEnvOption ?? config.strictEnv ?? config.runtime?.strictEnv)
 
+    function warn (message) {
+      if (logger) {
+        logger.warn(message)
+      } else {
+        process.emitWarning(message)
+      }
+    }
+
+    // Variables resolved by a fallback are always reported as a warning, never as an error: they did
+    // resolve to a value, so failing on them would change which configurations are able to boot.
+    // This is emitted before handling the missing ones so that a throw does not swallow it.
+    if (strictEnv && fallbackEnv.size > 0) {
+      const keys = Array.from(fallbackEnv).sort().join(', ')
+
+      warn(
+        'The configuration references the following environment variables which are not set ' +
+          `and have been replaced by a fallback value: ${keys}`
+      )
+    }
+
     if (strictEnv && missingEnv.size > 0) {
       const keys = Array.from(missingEnv).sort().join(', ')
 
       if (strictEnv === 'warn') {
-        const message = `The configuration references the following environment variables which are not set: ${keys}`
-
-        if (logger) {
-          logger.warn(message)
-        } else {
-          process.emitWarning(message)
-        }
+        warn(`The configuration references the following environment variables which are not set: ${keys}`)
       } else {
         throw new MissingEnvVariablesError(keys)
       }

package/lib/symbols.js

@@ -1,4 +1,5 @@
 export const kCanceled = Symbol('plt.foundation.canceled')
+export const kEnvFileFallbackKeys = Symbol('plt.foundation.envFileFallbackKeys')
 export const kFailedImport = Symbol('plt.foundation.failedImport')
 export const kHandledError = Symbol('plt.foundation.handledError')
 export const kMetadata = Symbol('plt.foundation.metadata')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/foundation",
-  "version": "3.64.0",
+  "version": "3.66.0",
   "description": "Platformatic Foundation",
   "main": "index.js",
   "types": "index.d.ts",
@@ -50,6 +50,7 @@
   "scripts": {
     "test": "npm run test:types && node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
     "test:types": "tstyche",
-    "lint": "eslint"
+    "lint": "eslint",
+    "lint:fix": "eslint --fix"
   }
 }