@platformatic/foundation 3.0.0-alpha.5 → 3.0.0-alpha.7

package/LICENSE

@@ -136,7 +136,7 @@
       with Licensor regarding such Contributions.
 
    6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
+      names, trademarks, application marks, or product names of the Licensor,
       except as required for reasonable and customary use in describing the
       origin of the Work and reproducing the content of the NOTICE file.
 

package/index.d.ts

@@ -3,8 +3,14 @@ import { JSONSchemaType } from 'ajv'
 import { EventEmitter } from 'node:events'
 import { Logger } from 'pino'
 
-// Configuration types
+// Symbols
+export declare const kCanceled: unique symbol
+export declare const kFailedImport: unique symbol
+export declare const kHandledError: unique symbol
 export declare const kMetadata: unique symbol
+export declare const kTimeout: unique symbol
+
+// Configuration types
 export declare const envVariablePattern: RegExp
 export declare const knownConfigurationFilesExtensions: string[]
 export declare const knownConfigurationFilesSchemas: RegExp[]
@@ -117,8 +123,13 @@ export declare const SchemaMustBeDefinedError: FastifyError
 export declare const ConfigurationDoesNotValidateAgainstSchemaError: FastifyError
 
 // Execution types
-export declare const kTimeout: unique symbol
 export declare function executeWithTimeout<T> (promise: Promise<T>, timeout: number, timeoutValue?: any): Promise<T>
+export declare function executeInParallel<T, Args extends any[]> (
+  fn: (...args: Args) => Promise<T>,
+  args: Args[],
+  concurrency?: number,
+  throwOnRejections?: boolean
+): Promise<T[]>
 
 // File system types
 export declare function removeDotSlash (path: string): string
@@ -167,7 +178,7 @@ export declare function buildPinoTimestamp (timestamp: string): Function
 export declare function buildPinoOptions (
   loggerConfig: any,
   serverConfig: any,
-  serviceId?: string,
+  applicationId?: string,
   workerId?: string,
   context?: any,
   root?: string
@@ -185,7 +196,6 @@ export declare const stdTimeFunctions: {
 }
 
 // Module types
-export declare const kFailedImport: unique symbol
 export declare const defaultPackageManager: string
 
 export declare function getLatestNpmVersion (pkg: string): Promise<string | null>
@@ -201,7 +211,7 @@ export declare function detectApplicationType (
 export declare function loadModule (require: NodeRequire, path: string): Promise<any>
 
 // Node types
-export declare function checkNodeVersionForServices (): void
+export declare function checkNodeVersionForApplications (): void
 export declare const features: {
   node: {
     reusePort: boolean
@@ -234,7 +244,7 @@ export declare const health: JSONSchemaType<object>
 export declare const healthWithoutDefaults: JSONSchemaType<object>
 export declare const telemetryExporter: JSONSchemaType<object>
 export declare const telemetry: JSONSchemaType<object>
-export declare const services: JSONSchemaType<object[]>
+export declare const applications: JSONSchemaType<object[]>
 export declare const runtimeUnwrappablePropertiesList: string[]
 export declare const runtimeProperties: JSONSchemaType<object>
 export declare const wrappedRuntimeProperties: JSONSchemaType<object>

package/index.js

@@ -10,3 +10,4 @@ export * from './lib/node.js'
 export * from './lib/object.js'
 export * from './lib/schema.js'
 export * from './lib/string.js'
+export * from './lib/symbols.js'

package/lib/cli.js

@@ -152,8 +152,8 @@ export function getRoot (positionals) {
   return root
 }
 
-export function serviceToEnvVariable (service) {
-  return `PLT_SERVICE_${service.toUpperCase().replaceAll(/[^A-Z0-9_]/g, '_')}_PATH`
+export function applicationToEnvVariable (application) {
+  return `PLT_APPLICATION_${application.toUpperCase().replaceAll(/[^A-Z0-9_]/g, '_')}_PATH`
 }
 
 export async function findRuntimeConfigurationFile (
@@ -166,7 +166,7 @@ export async function findRuntimeConfigurationFile (
 ) {
   let configFile = await findConfigurationFileRecursive(root, configurationFile, '@platformatic/runtime')
 
-  // If a runtime was not found, search for service file that we wrap in a runtime
+  // If a runtime was not found, search for application file that we wrap in a runtime
   if (!configFile && !configurationFile) {
     configFile = await findConfigurationFileRecursive(root, configurationFile)
   }

package/lib/configuration.js

@@ -17,13 +17,13 @@ import {
 } from './errors.js'
 import { isFileAccessible } from './file-system.js'
 import { loadModule, splitModuleFromVersion } from './module.js'
+import { kMetadata } from './symbols.js'
 
 const { parse: parseJSON5, stringify: rawStringifyJSON5 } = JSON5
 const { parse: parseTOML, stringify: stringifyTOML } = toml
 
 const kReplaceEnvIgnore = Symbol('plt.foundation.replaceEnvIgnore')
 
-export const kMetadata = Symbol('plt.foundation.metadata')
 export const envVariablePattern = /(?:\{{1,2})([a-z0-9_]+)(?:\}{1,2})/i
 
 export const knownConfigurationFilesExtensions = ['json', 'json5', 'yaml', 'yml', 'toml', 'tml']
@@ -120,7 +120,8 @@ export function printValidationErrors (err) {
 
 export function listRecognizedConfigurationFiles (suffixes, extensions) {
   if (typeof suffixes === 'undefined' || suffixes === null) {
-    suffixes = ['runtime', 'service', 'application', 'db', 'composer']
+    // composer is retained for backward compatibility with V2
+    suffixes = ['runtime', 'service', 'application', 'db', 'gateway', 'composer']
   } else if (suffixes && !Array.isArray(suffixes)) {
     suffixes = [suffixes]
   } else if (!suffixes) {

package/lib/execution.js

@@ -1,7 +1,6 @@
 import { Unpromise } from '@watchable/unpromise'
 import { setTimeout as sleep } from 'node:timers/promises'
-
-export const kTimeout = Symbol('plt.utils.timeout')
+import { kCanceled, kTimeout } from './symbols.js'
 
 export async function executeWithTimeout (promise, timeout, timeoutValue = kTimeout) {
   const ac = new AbortController()
@@ -11,3 +10,62 @@ export async function executeWithTimeout (promise, timeout, timeoutValue = kTime
     return value
   })
 }
+
+export async function executeInParallel (fn, args, concurrency = 5, throwOnRejections = true, throwAllErrors = false) {
+  const { promise, resolve } = Promise.withResolvers()
+  const results = new Map()
+  let current = 0
+  let pending = 0
+  let firstError
+  let terminated = false
+
+  if (args.length === 0) {
+    return []
+  }
+
+  function scheduleNext () {
+    // While we have capacity and there are still items to process
+    while (current < args.length && pending < concurrency) {
+      const i = current++
+      pending++
+
+      // Perform the async operation
+      fn(...args[i])
+        .then(result => {
+          results.set(i, result)
+        })
+        .catch(err => {
+          results.set(i, err)
+          firstError = err
+        })
+        .finally(() => {
+          pending--
+
+          if (terminated) {
+            return
+          }
+
+          if ((current === args.length && pending === 0) || (firstError && throwOnRejections)) {
+            terminated = true
+            resolve()
+          } else {
+            scheduleNext()
+          }
+        })
+    }
+  }
+
+  scheduleNext()
+  await promise
+
+  const returnedValues = []
+  for (let j = 0; j < args.length; j++) {
+    returnedValues.push(results.has(j) ? results.get(j) : kCanceled)
+  }
+
+  if (firstError && throwOnRejections) {
+    throw throwAllErrors ? AggregateError(returnedValues, 'One or more operations failed.') : firstError
+  }
+
+  return returnedValues
+}

package/lib/logger.js

@@ -54,13 +54,13 @@ export function buildPinoTimestamp (timestamp) {
   return stdTimeFunctions[timestamp]
 }
 
-export function buildPinoOptions (loggerConfig, serverConfig, serviceId, workerId, context, root) {
+export function buildPinoOptions (loggerConfig, serverConfig, applicationId, workerId, context, root) {
   const pinoOptions = {
     level: loggerConfig?.level ?? serverConfig?.level ?? 'trace'
   }
 
-  if (serviceId) {
-    pinoOptions.name = serviceId
+  if (applicationId) {
+    pinoOptions.name = applicationId
   }
 
   if (loggerConfig?.base) {

package/lib/module.js

@@ -4,11 +4,10 @@ import { resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 import { request } from 'undici'
 import { hasJavascriptFiles } from './file-system.js'
+import { kFailedImport } from './symbols.js'
 
 let platformaticPackageVersion
 
-export const kFailedImport = Symbol('plt.utils.failedImport')
-
 export const defaultPackageManager = 'npm'
 
 export async function getLatestNpmVersion (pkg) {

package/lib/node.js

@@ -3,7 +3,7 @@ import { lt, satisfies } from 'semver'
 
 const currentPlatform = platform()
 
-export function checkNodeVersionForServices () {
+export function checkNodeVersionForApplications () {
   const currentVersion = process.version
   const minimumVersion = '22.18.0'
 

package/lib/schema.js

@@ -618,13 +618,13 @@ export const telemetry = {
         }
       ]
     },
-    serviceName: {
+    applicationName: {
       type: 'string',
-      description: 'The name of the service. Defaults to the folder name if not specified.'
+      description: 'The name of the application. Defaults to the folder name if not specified.'
     },
     version: {
       type: 'string',
-      description: 'The version of the service (optional)'
+      description: 'The version of the application (optional)'
     },
     skip: {
       type: 'array',
@@ -655,11 +655,11 @@ export const telemetry = {
       ]
     }
   },
-  required: ['serviceName'],
+  required: ['applicationName'],
   additionalProperties: false
 }
 
-export const services = {
+export const applications = {
   type: 'array',
   items: {
     type: 'object',
@@ -689,6 +689,13 @@ export const services = {
       },
       workers,
       health: { ...healthWithoutDefaults },
+      dependencies: {
+        type: 'array',
+        items: {
+          type: 'string'
+        },
+        default: []
+      },
       arguments: {
         type: 'array',
         items: {
@@ -750,10 +757,11 @@ export const services = {
 export const runtimeUnwrappablePropertiesList = [
   '$schema',
   'entrypoint',
+  'applications',
   'autoload',
-  'services',
+  'applications',
   'web',
-  'resolvedServicesBasePath'
+  'resolvedApplicationsBasePath'
 ]
 
 export const runtimeProperties = {
@@ -802,6 +810,12 @@ export const runtimeProperties = {
             workers,
             health: { ...healthWithoutDefaults },
             preload,
+            dependencies: {
+              type: 'array',
+              items: {
+                type: 'string'
+              }
+            },
             arguments: {
               type: 'array',
               items: {
@@ -816,9 +830,10 @@ export const runtimeProperties = {
       }
     }
   },
-  services,
+  applications,
+  services: applications,
+  web: applications,
   workers: { ...workers, default: 1 },
-  web: services,
   logger,
   server,
   startTimeout: {
@@ -849,7 +864,7 @@ export const runtimeProperties = {
         ],
         default: 10000
       },
-      service: {
+      application: {
         anyOf: [
           {
             type: 'number',
@@ -861,7 +876,7 @@ export const runtimeProperties = {
       }
     },
     default: {},
-    required: ['runtime', 'service'],
+    required: ['runtime', 'application'],
     additionalProperties: false
   },
   health,
@@ -1081,7 +1096,7 @@ export const runtimeProperties = {
       }
     }
   },
-  serviceTimeout: {
+  applicationTimeout: {
     anyOf: [
       {
         type: 'number',
@@ -1101,7 +1116,7 @@ export const runtimeProperties = {
     ],
     default: 30000 // 5 minutes
   },
-  resolvedServicesBasePath: {
+  resolvedApplicationsBasePath: {
     type: 'string',
     default: 'external'
   },
@@ -1182,7 +1197,7 @@ export const schemaComponents = {
   healthWithoutDefaults,
   telemetryExporter,
   telemetry,
-  services,
+  applications,
   runtimeProperties,
   wrappedRuntimeProperties,
   wrappedRuntime

package/lib/symbols.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/foundation",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.7",
   "description": "Platformatic Foundation",
   "main": "index.js",
   "types": "index.d.ts",
@@ -33,8 +33,8 @@
     "yaml": "^2.4.1"
   },
   "devDependencies": {
-    "borp": "^0.20.0",
     "c8": "^10.0.0",
+    "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
     "fastify": "^5.0.0",
     "neostandard": "^0.12.0",
@@ -46,8 +46,7 @@
     "node": ">=22.18.0"
   },
   "scripts": {
-    "test": "npm run lint && node --test --test-concurrency=1 --test-timeout=1200000 test/*.test.js",
-    "coverage": "c8 -r html -r text node --test --test-concurrency=1 --test-timeout=1200000 test/*.test.js",
+    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
     "lint": "eslint"
   }
 }