@platformatic/runtime 3.0.0-alpha.4 → 3.0.0-alpha.6

package/lib/generator.js

@@ -1,27 +1,22 @@
-'use strict'
-
-const createError = require('@fastify/error')
-const { BaseGenerator } = require('@platformatic/generators')
-const { existsSync } = require('node:fs')
-const { join, basename } = require('node:path')
-const { envObjectToString } = require('@platformatic/generators/lib/utils')
-const { readFile, readdir, stat } = require('node:fs/promises')
-const { transform } = require('./config')
-const { getServiceTemplateFromSchemaUrl } = require('@platformatic/generators/lib/utils')
-const { DotEnvTool } = require('dotenv-tool')
-const { getArrayDifference } = require('./utils')
-const { schema } = require('./schema')
-const { pathToFileURL } = require('node:url')
-const {
-  safeRemove,
-  generateDashedName,
+import createError from '@fastify/error'
+import {
+  defaultPackageManager,
   findConfigurationFile,
+  generateDashedName,
+  kMetadata,
   loadConfiguration,
   loadConfigurationFile,
-  kMetadata,
-  defaultPackageManager
-} = require('@platformatic/foundation')
-const { createRequire } = require('node:module')
+  safeRemove
+} from '@platformatic/foundation'
+import { BaseGenerator, envObjectToString, getApplicationTemplateFromSchemaUrl } from '@platformatic/generators'
+import { existsSync } from 'node:fs'
+import { readFile, readdir, stat } from 'node:fs/promises'
+import { createRequire } from 'node:module'
+import { basename, join } from 'node:path'
+import { pathToFileURL } from 'node:url'
+import { transform } from './config.js'
+import { schema } from './schema.js'
+import { getArrayDifference } from './utils.js'
 
 const wrappableProperties = {
   logger: {
@@ -38,11 +33,11 @@ const engines = {
   node: '>=22.18.0'
 }
 
-const ERROR_PREFIX = 'PLT_RUNTIME_GEN'
+export const ERROR_PREFIX = 'PLT_RUNTIME_GEN'
 
-const NoServiceNamedError = createError(
-  `${ERROR_PREFIX}_NO_SERVICE_FOUND`,
-  "No service named '%s' has been added to this runtime."
+const NoApplicationNamedError = createError(
+  `${ERROR_PREFIX}_NO_APPLICATION_FOUND`,
+  "No application named '%s' has been added to this runtime."
 )
 const NoEntryPointError = createError(`${ERROR_PREFIX}_NO_ENTRYPOINT`, 'No entrypoint had been defined.')
 
@@ -55,46 +50,53 @@ function getRuntimeBaseEnvVars (config) {
   }
 }
 
-class RuntimeGenerator extends BaseGenerator {
+// This is needed as dotenv-tool is not loading with ESM currently
+export function createDotenvTool (...args) {
+  const { DotEnvTool } = createRequire(import.meta.url)('dotenv-tool')
+  return new DotEnvTool(...args)
+}
+
+export class RuntimeGenerator extends BaseGenerator {
   constructor (opts) {
     super({
       ...opts,
       module: '@platformatic/runtime'
     })
     this.runtimeName = opts.name
-    this.servicesFolder = opts.servicesFolder ?? 'services'
-    this.services = []
-    this.existingServices = []
+    this.applicationsFolder = opts.applicationsFolder ?? 'applications'
+    this.applications = []
+    this.existingApplications = []
     this.entryPoint = null
     this.packageManager = opts.packageManager ?? defaultPackageManager
   }
 
-  async addService (service, name) {
-    // ensure service config is correct
-    const originalConfig = service.config
-    const serviceName = name || generateDashedName()
+  async addApplication (application, name) {
+    // ensure application config is correct
+    const originalConfig = application.config
+    const applicationName = name || generateDashedName()
     const newConfig = {
       ...originalConfig,
       isRuntimeContext: true,
-      serviceName
+      applicationName
     }
-    // reset all files previously generated by the service
-    service.reset()
-    service.setConfig(newConfig)
-    this.services.push({
-      name: serviceName,
-      service
+    // reset all files previously generated by the application
+    application.reset()
+    application.setConfig(newConfig)
+    this.applications.push({
+      name: applicationName,
+      application
     })
 
-    service.setRuntime(this)
+    application.setRuntime(this)
   }
 
   setEntryPoint (entryPoint) {
-    const service = this.existingServices.includes(entryPoint) || this.services.find(svc => svc.name === entryPoint)
-    if (!service) {
-      throw new NoServiceNamedError(entryPoint)
+    const application =
+      this.existingApplications.includes(entryPoint) || this.applications.find(svc => svc.name === entryPoint)
+    if (!application) {
+      throw new NoApplicationNamedError(entryPoint)
     }
-    this.entryPoint = service
+    this.entryPoint = application
   }
 
   async generatePackageJson () {
@@ -106,8 +108,7 @@ class RuntimeGenerator extends BaseGenerator {
         start: this.config.startCommand ?? 'platformatic start'
       },
       devDependencies: {
-        fastify: `^${this.fastifyVersion}`,
-        borp: `${this.pkgData.devDependencies.borp}`
+        fastify: `^${this.fastifyVersion}`
       },
       dependencies: {
         '@platformatic/runtime': `^${this.platformaticVersion}`,
@@ -119,24 +120,24 @@ class RuntimeGenerator extends BaseGenerator {
     }
 
     if (this.packageManager === 'npm' || this.packageManager === 'yarn') {
-      template.workspaces = [this.servicesFolder + '/*']
+      template.workspaces = [this.applicationsFolder + '/*']
     }
 
     return template
   }
 
   async _beforePrepare () {
-    this.setServicesDirectory()
-    this.setServicesConfigValues()
-    this.addServicesDependencies()
+    this.setApplicationsDirectory()
+    this.setApplicationsConfigValues()
+    this.addApplicationsDependencies()
 
     this.addEnvVars(getRuntimeBaseEnvVars(this.config), { overwrite: false, default: true })
   }
 
-  addServicesDependencies () {
-    this.services.forEach(({ service }) => {
-      if (service.config.dependencies) {
-        Object.entries(service.config.dependencies).forEach(kv => {
+  addApplicationsDependencies () {
+    this.applications.forEach(({ application }) => {
+      if (application.config.dependencies) {
+        Object.entries(application.config.dependencies).forEach(kv => {
           this.config.dependencies[kv[0]] = kv[1]
         })
       }
@@ -159,8 +160,8 @@ class RuntimeGenerator extends BaseGenerator {
       const { PLT_ROOT, ...existingEnvironment } = this.existingConfig[kMetadata].env
       this.config.env = existingEnvironment
       this.config.port = this.config.env.PORT
-      this.entryPoint = this.existingConfig.services.find(svc => svc.entrypoint)
-      this.existingServices = this.existingConfig.services.map(s => s.id)
+      this.entryPoint = this.existingConfig.applications.find(svc => svc.entrypoint)
+      this.existingApplications = this.existingConfig.applications.map(s => s.id)
 
       this.updateRuntimeConfig(this.existingConfigRaw)
       this.updateRuntimeEnv(await readFile(join(this.targetDirectory, '.env'), 'utf-8'))
@@ -170,8 +171,8 @@ class RuntimeGenerator extends BaseGenerator {
   async prepare () {
     await this.populateFromExistingConfig()
     if (this.existingConfig) {
-      this.setServicesDirectory()
-      this.setServicesConfigValues()
+      this.setApplicationsDirectory()
+      this.setApplicationsConfigValues()
       await this._afterPrepare()
       return {
         env: this.config.env,
@@ -182,11 +183,11 @@ class RuntimeGenerator extends BaseGenerator {
     }
   }
 
-  setServicesConfigValues () {
-    this.services.forEach(({ service }) => {
-      if (!service.config) {
+  setApplicationsConfigValues () {
+    this.applications.forEach(({ application }) => {
+      if (!application.config) {
         // set default config
-        service.setConfig()
+        application.setConfig()
       }
     })
   }
@@ -197,7 +198,7 @@ class RuntimeGenerator extends BaseGenerator {
       entrypoint: this.entryPoint.name,
       watch: true,
       autoload: {
-        path: this.config.autoload || this.servicesFolder,
+        path: this.config.autoload || this.applicationsFolder,
         exclude: ['docs']
       },
       ...wrappableProperties
@@ -210,11 +211,11 @@ class RuntimeGenerator extends BaseGenerator {
     if (!this.entryPoint) {
       throw new NoEntryPointError()
     }
-    const servicesEnv = await this.prepareServiceFiles()
+    const applicationsEnv = await this.prepareApplicationFiles()
     this.addEnvVars({
       ...this.config.env,
       ...this.getRuntimeEnv(),
-      ...servicesEnv
+      ...applicationsEnv
     })
 
     this.updateRuntimeEnv(envObjectToString(this.config.env))
@@ -227,25 +228,25 @@ class RuntimeGenerator extends BaseGenerator {
 
     return {
       targetDirectory: this.targetDirectory,
-      env: servicesEnv
+      env: applicationsEnv
     }
   }
 
   async writeFiles () {
-    for (const { service } of this.services) {
-      await service._beforeWriteFiles?.(this)
+    for (const { application } of this.applications) {
+      await application._beforeWriteFiles?.(this)
     }
 
     await super.writeFiles()
 
     if (!this.config.isUpdating) {
-      for (const { service } of this.services) {
-        await service.writeFiles()
+      for (const { application } of this.applications) {
+        await application.writeFiles()
       }
     }
 
-    for (const { service } of this.services) {
-      await service._afterWriteFiles?.(this)
+    for (const { application } of this.applications) {
+      await application._afterWriteFiles?.(this)
     }
   }
 
@@ -265,43 +266,43 @@ class RuntimeGenerator extends BaseGenerator {
     })
   }
 
-  setServicesDirectory () {
-    this.services.forEach(({ service }) => {
-      if (!service.config) {
+  setApplicationsDirectory () {
+    this.applications.forEach(({ application }) => {
+      if (!application.config) {
         // set default config
-        service.setConfig()
+        application.setConfig()
       }
       let basePath
       if (this.existingConfig) {
         basePath = this.existingConfig.autoload.path
       } else {
-        basePath = join(this.targetDirectory, this.config.autoload || this.servicesFolder)
+        basePath = join(this.targetDirectory, this.config.autoload || this.applicationsFolder)
       }
-      this.servicesBasePath = basePath
-      service.setTargetDirectory(join(basePath, service.config.serviceName))
+      this.applicationsBasePath = basePath
+      application.setTargetDirectory(join(basePath, application.config.applicationName))
     })
   }
 
-  setServicesConfig (configToOverride) {
-    this.services.forEach(service => {
-      const originalConfig = service.config
-      service.setConfig({
+  setApplicationsConfig (configToOverride) {
+    this.applications.forEach(application => {
+      const originalConfig = application.config
+      application.setConfig({
         ...originalConfig,
         ...configToOverride
       })
     })
   }
 
-  async prepareServiceFiles () {
-    let servicesEnv = {}
-    for (const svc of this.services) {
-      const svcEnv = await svc.service.prepare()
-      servicesEnv = {
-        ...servicesEnv,
+  async prepareApplicationFiles () {
+    let applicationsEnv = {}
+    for (const svc of this.applications) {
+      const svcEnv = await svc.application.prepare()
+      applicationsEnv = {
+        ...applicationsEnv,
         ...svcEnv.env
       }
     }
-    return servicesEnv
+    return applicationsEnv
   }
 
   getConfigFieldsDefinitions () {
@@ -319,8 +320,8 @@ class RuntimeGenerator extends BaseGenerator {
   }
 
   async postInstallActions () {
-    for (const { service } of this.services) {
-      await service.postInstallActions()
+    for (const { application } of this.applications) {
+      await application.postInstallActions()
     }
   }
 
@@ -332,122 +333,122 @@ class RuntimeGenerator extends BaseGenerator {
 
   async loadFromDir () {
     const output = {
-      services: []
+      applications: []
     }
     const runtimePkgConfigFileData = JSON.parse(await readFile(join(this.targetDirectory, this.runtimeConfig), 'utf-8'))
-    const servicesPath = join(this.targetDirectory, runtimePkgConfigFileData.autoload.path)
+    const applicationsPath = join(this.targetDirectory, runtimePkgConfigFileData.autoload.path)
 
-    // load all services
-    const allServices = await readdir(servicesPath)
-    for (const s of allServices) {
+    // load all applications
+    const allApplications = await readdir(applicationsPath)
+    for (const s of allApplications) {
       // check is a directory
-      const currentServicePath = join(servicesPath, s)
-      const dirStat = await stat(currentServicePath)
+      const currentApplicationPath = join(applicationsPath, s)
+      const dirStat = await stat(currentApplicationPath)
       if (dirStat.isDirectory()) {
-        // load the service config
-        const configFile = await findConfigurationFile(currentServicePath)
-        const servicePltJson = JSON.parse(await readFile(join(currentServicePath, configFile), 'utf-8'))
+        // load the application config
+        const configFile = await findConfigurationFile(currentApplicationPath)
+        const applicationPltJson = JSON.parse(await readFile(join(currentApplicationPath, configFile), 'utf-8'))
         // get module to load
-        const template = servicePltJson.module || getServiceTemplateFromSchemaUrl(servicePltJson.$schema)
-        const Generator = await this._getGeneratorForTemplate(currentServicePath, template)
+        const template = applicationPltJson.module || getApplicationTemplateFromSchemaUrl(applicationPltJson.$schema)
+        const Generator = await this._getGeneratorForTemplate(currentApplicationPath, template)
         const instance = new Generator({
           logger: this.logger
         })
-        this.addService(instance, s)
-        output.services.push(await instance.loadFromDir(s, this.targetDirectory))
+        this.addApplication(instance, s)
+        output.applications.push(await instance.loadFromDir(s, this.targetDirectory))
       }
     }
     return output
   }
 
   async update (newConfig) {
-    let allServicesDependencies = {}
+    let allApplicationsDependencies = {}
     const runtimeAddedEnvKeys = []
 
     this.config.isUpdating = true
     const currrentPackageJson = JSON.parse(await readFile(join(this.targetDirectory, 'package.json'), 'utf-8'))
     const currentRuntimeDependencies = currrentPackageJson.dependencies
-    // check all services are present with the same template
-    const allCurrentServicesNames = this.services.map(s => s.name)
-    const allNewServicesNames = newConfig.services.map(s => s.name)
+    // check all applications are present with the same template
+    const allCurrentApplicationsNames = this.applications.map(s => s.name)
+    const allNewApplicationsNames = newConfig.applications.map(s => s.name)
     // load dotenv tool
-    const envTool = new DotEnvTool({
+    const envTool = createDotenvTool({
       path: join(this.targetDirectory, '.env')
     })
 
     await envTool.load()
 
-    const removedServices = getArrayDifference(allCurrentServicesNames, allNewServicesNames)
-    if (removedServices.length > 0) {
-      for (const removedService of removedServices) {
-        // handle service delete
+    const removedApplications = getArrayDifference(allCurrentApplicationsNames, allNewApplicationsNames)
+    if (removedApplications.length > 0) {
+      for (const removedApplication of removedApplications) {
+        // handle application delete
 
         // delete env variables
-        const s = this.services.find(f => f.name === removedService)
+        const s = this.applications.find(f => f.name === removedApplication)
         const allKeys = envTool.getKeys()
         allKeys.forEach(k => {
-          if (k.startsWith(`PLT_${s.service.config.envPrefix}`)) {
+          if (k.startsWith(`PLT_${s.application.config.envPrefix}`)) {
             envTool.deleteKey(k)
           }
         })
 
         // delete dependencies
-        const servicePath = join(this.targetDirectory, this.servicesFolder, s.name)
-        const configFile = await findConfigurationFile(servicePath)
-        const servicePackageJson = JSON.parse(await readFile(join(servicePath, configFile), 'utf-8'))
-        if (servicePackageJson.plugins && servicePackageJson.plugins.packages) {
-          servicePackageJson.plugins.packages.forEach(p => {
+        const applicationPath = join(this.targetDirectory, this.applicationsFolder, s.name)
+        const configFile = await findConfigurationFile(applicationPath)
+        const applicationPackageJson = JSON.parse(await readFile(join(applicationPath, configFile), 'utf-8'))
+        if (applicationPackageJson.plugins && applicationPackageJson.plugins.packages) {
+          applicationPackageJson.plugins.packages.forEach(p => {
             delete currrentPackageJson.dependencies[p.name]
           })
         }
         // delete directory
-        await safeRemove(join(this.targetDirectory, this.servicesFolder, s.name))
+        await safeRemove(join(this.targetDirectory, this.applicationsFolder, s.name))
       }
-      // throw new CannotRemoveServiceOnUpdateError(removedServices.join(', '))
+      // throw new CannotRemoveApplicationOnUpdateError(removedApplications.join(', '))
     }
 
-    // handle new services
-    for (const newService of newConfig.services) {
-      // create generator for the service
-      const ServiceGenerator = await this._getGeneratorForTemplate(
+    // handle new applications
+    for (const newApplication of newConfig.applications) {
+      // create generator for the application
+      const ApplicationGenerator = await this._getGeneratorForTemplate(
         join(this.targetDirectory, 'package.json'),
-        newService.template
+        newApplication.template
       )
-      const serviceInstance = new ServiceGenerator({
+      const applicationInstance = new ApplicationGenerator({
         logger: this.logger
       })
       const baseConfig = {
         isRuntimeContext: true,
-        targetDirectory: join(this.targetDirectory, this.servicesFolder, newService.name),
-        serviceName: newService.name,
+        targetDirectory: join(this.targetDirectory, this.applicationsFolder, newApplication.name),
+        applicationName: newApplication.name,
         plugin: true
       }
-      if (allCurrentServicesNames.includes(newService.name)) {
-        // update existing services env values
-        // otherwise, is a new service
+      if (allCurrentApplicationsNames.includes(newApplication.name)) {
+        // update existing applications env values
+        // otherwise, is a new application
         baseConfig.isUpdating = true
 
-        // handle service's plugin differences
-        const oldServiceMetadata = await serviceInstance.loadFromDir(newService.name, this.targetDirectory)
-        const oldServicePackages = oldServiceMetadata.plugins.map(meta => meta.name)
-        const newServicePackages = newService.plugins.map(meta => meta.name)
-        const pluginsToRemove = getArrayDifference(oldServicePackages, newServicePackages)
+        // handle application's plugin differences
+        const oldApplicationMetadata = await applicationInstance.loadFromDir(newApplication.name, this.targetDirectory)
+        const oldApplicationPackages = oldApplicationMetadata.plugins.map(meta => meta.name)
+        const newApplicationPackages = newApplication.plugins.map(meta => meta.name)
+        const pluginsToRemove = getArrayDifference(oldApplicationPackages, newApplicationPackages)
         pluginsToRemove.forEach(p => delete currentRuntimeDependencies[p])
       } else {
-        // add service to the generator
-        this.services.push({
-          name: newService.name,
-          service: serviceInstance
+        // add application to the generator
+        this.applications.push({
+          name: newApplication.name,
+          application: applicationInstance
         })
       }
-      serviceInstance.setConfig(baseConfig)
-      serviceInstance.setConfigFields(newService.fields)
+      applicationInstance.setConfig(baseConfig)
+      applicationInstance.setConfigFields(newApplication.fields)
 
-      const serviceEnvPrefix = `PLT_${serviceInstance.config.envPrefix}`
-      for (const plug of newService.plugins) {
-        await serviceInstance.addPackage(plug)
+      const applicationEnvPrefix = `PLT_${applicationInstance.config.envPrefix}`
+      for (const plug of newApplication.plugins) {
+        await applicationInstance.addPackage(plug)
         for (const opt of plug.options) {
-          const key = `${serviceEnvPrefix}_${opt.name}`
+          const key = `${applicationEnvPrefix}_${opt.name}`
           runtimeAddedEnvKeys.push(key)
           const value = opt.value
           if (envTool.hasKey(key)) {
@@ -457,18 +458,18 @@ class RuntimeGenerator extends BaseGenerator {
           }
         }
       }
-      allServicesDependencies = { ...allServicesDependencies, ...serviceInstance.config.dependencies }
-      const afterPrepareMetadata = await serviceInstance.prepare()
-      await serviceInstance.writeFiles()
-      // cleanup runtime env removing keys not present anymore in service plugins
+      allApplicationsDependencies = { ...allApplicationsDependencies, ...applicationInstance.config.dependencies }
+      const afterPrepareMetadata = await applicationInstance.prepare()
+      await applicationInstance.writeFiles()
+      // cleanup runtime env removing keys not present anymore in application plugins
       const allKeys = envTool.getKeys()
       allKeys.forEach(k => {
-        if (k.startsWith(`${serviceEnvPrefix}_FST_PLUGIN`) && !runtimeAddedEnvKeys.includes(k)) {
+        if (k.startsWith(`${applicationEnvPrefix}_FST_PLUGIN`) && !runtimeAddedEnvKeys.includes(k)) {
           envTool.deleteKey(k)
         }
       })
 
-      // add service env variables to runtime env
+      // add application env variables to runtime env
       Object.entries(afterPrepareMetadata.env).forEach(([key, value]) => {
         envTool.addKey(key, value)
       })
@@ -476,7 +477,7 @@ class RuntimeGenerator extends BaseGenerator {
     // update runtime package.json dependencies
     currrentPackageJson.dependencies = {
       ...currrentPackageJson.dependencies,
-      ...allServicesDependencies
+      ...allApplicationsDependencies
     }
     this.addFile({
       path: '',
@@ -549,7 +550,7 @@ class RuntimeGenerator extends BaseGenerator {
   }
 }
 
-class WrappedGenerator extends BaseGenerator {
+export class WrappedGenerator extends BaseGenerator {
   async prepare () {
     await this.getPlatformaticVersion()
     await this.#updateEnvironment()
@@ -637,8 +638,3 @@ class WrappedGenerator extends BaseGenerator {
     return contents + suffix
   }
 }
-
-module.exports = {
-  RuntimeGenerator,
-  WrappedGenerator
-}

package/lib/logger.js

@@ -1,9 +1,9 @@
-'use strict'
+import { buildPinoFormatters, buildPinoTimestamp } from '@platformatic/foundation'
+import { isatty } from 'node:tty'
+import pino from 'pino'
+import pretty from 'pino-pretty'
 
-const { isatty } = require('node:tty')
-const pino = require('pino')
-const pretty = require('pino-pretty')
-const { abstractLogger, buildPinoFormatters, buildPinoTimestamp } = require('@platformatic/foundation')
+export { abstractLogger } from '@platformatic/foundation'
 
 const customPrettifiers = {
   name (name, _, obj) {
@@ -17,7 +17,7 @@ const customPrettifiers = {
 }
 
 // Create the runtime logger
-async function createLogger (config) {
+export async function createLogger (config) {
   const loggerConfig = { ...config.logger, transport: undefined }
   if (config.logger.base === null) {
     loggerConfig.base = undefined
@@ -55,5 +55,3 @@ async function createLogger (config) {
 
   return [pino(loggerConfig, multiStream), multiStream]
 }
-
-module.exports = { abstractLogger, createLogger }