@platformatic/foundation 3.62.2 → 3.62.4

package/index.d.ts

@@ -85,6 +85,7 @@ export type ConfigurationOptions<T = {}> = Partial<{
   replaceEnv: boolean
   replaceEnvIgnore: string[]
   onMissingEnv: (key: string) => string | undefined
+  strictEnv: boolean | 'warn'
   fixPaths: boolean
   logger: Logger
   root: string
@@ -181,6 +182,7 @@ export declare const SourceMissingError: FastifyError
 export declare const RootMissingError: FastifyError
 export declare const SchemaMustBeDefinedError: FastifyError
 export declare const ConfigurationDoesNotValidateAgainstSchemaError: FastifyError
+export declare const MissingEnvVariablesError: FastifyError
 
 // Execution types
 export declare function executeWithTimeout<T> (promise: Promise<T>, timeout: number, timeoutValue?: any): Promise<T>

package/lib/configuration.js

@@ -12,6 +12,7 @@ import {
   CannotParseConfigFileError,
   ConfigurationDoesNotValidateAgainstSchemaError,
   InvalidConfigFileExtensionError,
+  MissingEnvVariablesError,
   RootMissingError,
   SourceMissingError
 } from './errors.js'
@@ -442,6 +443,16 @@ export function replaceEnv (config, env, onMissingEnv, ignore) {
   return config
 }
 
+function normalizeStrictEnv (value) {
+  if (value === 'warn') {
+    return 'warn'
+  } else if (value === 'false' || value === '') {
+    return false
+  }
+
+  return Boolean(value)
+}
+
 export async function loadConfiguration (source, schema, options = {}) {
   const {
     validate: shouldValidate,
@@ -453,6 +464,7 @@ export async function loadConfiguration (source, schema, options = {}) {
     replaceEnv: shouldReplaceEnv,
     replaceEnvIgnore,
     onMissingEnv,
+    strictEnv: strictEnvOption,
     fixPaths,
     logger,
     skipMetadata,
@@ -487,7 +499,42 @@ export async function loadConfiguration (source, schema, options = {}) {
   env.PLT_ROOT = root
 
   if (shouldReplaceEnv) {
-    config = replaceEnv(config, env, onMissingEnv, replaceEnvIgnore)
+    const missingEnv = new Set()
+
+    config = replaceEnv(
+      config,
+      env,
+      key => {
+        const value = onMissingEnv?.(key)
+
+        if (typeof value === 'undefined' || value === null) {
+          missingEnv.add(key)
+        }
+
+        return value
+      },
+      replaceEnvIgnore
+    )
+
+    // strictEnv can be set programmatically or in the configuration file itself, either at the top level
+    // (runtime configurations) or in the runtime property (capabilities configurations).
+    const strictEnv = normalizeStrictEnv(strictEnvOption ?? config.strictEnv ?? config.runtime?.strictEnv)
+
+    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)
+        }
+      } else {
+        throw new MissingEnvVariablesError(keys)
+      }
+    }
   }
 
   const moduleInfo = extractModuleFromSchemaUrl(config)

package/lib/errors.js

@@ -56,3 +56,7 @@ export const ConfigurationDoesNotValidateAgainstSchemaError = createError(
   `${ERROR_PREFIX}_CONFIGURATION_DOES_NOT_VALIDATE_AGAINST_SCHEMA`,
   'The configuration does not validate against the configuration schema'
 )
+export const MissingEnvVariablesError = createError(
+  `${ERROR_PREFIX}_MISSING_ENV_VARIABLES`,
+  'The configuration references the following environment variables which are not set: %s'
+)

package/lib/module.js

@@ -17,6 +17,11 @@ export const applicationTypes = [
   { name: '@platformatic/next', label: 'Next.js', dependencies: ['next'] },
   { name: '@platformatic/remix', label: 'Remix', dependencies: ['@remix-run/dev'] },
   { name: '@platformatic/astro', label: 'Astro', dependencies: ['astro'] },
+  { name: '@platformatic/react-router', label: 'React Router', dependencies: ['@react-router/dev'] },
+  { name: '@platformatic/nuxt', label: 'Nuxt', dependencies: ['nuxt'] },
+  { name: '@platformatic/tanstack', label: 'TanStack Start', dependencies: ['@tanstack/react-start'] },
+  // Nitro applications often use Vite, so Nitro must be checked first.
+  { name: '@platformatic/nitro', label: 'Nitro', dependencies: ['nitro', 'nitropack'] },
   // Since Vite is often used with other frameworks, we must check for Vite last amongst frontend frameworks
   { name: '@platformatic/vite', label: 'Vite', dependencies: ['vite'] },
   {

package/lib/schema.js

@@ -1533,6 +1533,11 @@ export const runtimeProperties = {
   envfile: {
     type: 'string'
   },
+  strictEnv: {
+    anyOf: [{ type: 'boolean' }, { type: 'string' }],
+    description:
+      'When set to true, the configuration loading fails if a {PLT_*} placeholder references an environment variable which is not set. When set to "warn", a warning listing the missing variables is logged but the placeholders are still replaced with an empty string. Defaults to false.'
+  },
   sourceMaps: {
     type: 'boolean',
     default: false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/foundation",
-  "version": "3.62.2",
+  "version": "3.62.4",
   "description": "Platformatic Foundation",
   "main": "index.js",
   "types": "index.d.ts",
@@ -37,7 +37,7 @@
     "c8": "^11.0.0",
     "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
-    "fastify": "^5.7.0",
+    "fastify": "^5.0.0",
     "neostandard": "^0.12.0",
     "pino": "^9.9.0",
     "pino-test": "^1.0.1",