@platformatic/runtime 1.12.1 → 1.13.1

package/index.js

@@ -6,6 +6,7 @@ const RuntimeApi = require('./lib/api')
 const { compile } = require('./lib/compile')
 const { loadConfig } = require('./lib/load-config')
 const errors = require('./lib/errors')
+const RuntimeGenerator = require('./lib/generator/runtime-generator')
 
 module.exports.buildServer = buildServer
 module.exports.platformaticRuntime = platformaticRuntime
@@ -16,3 +17,4 @@ module.exports.startCommand = startCommand
 module.exports.compile = compile
 module.exports.loadConfig = loadConfig
 module.exports.errors = errors
+module.exports.Generator = RuntimeGenerator

package/lib/generator/errors.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const createError = require('@fastify/error')
+
+const ERROR_PREFIX = 'PLT_RUNTIME_GEN'
+
+module.exports = {
+  NoServiceNamedError: createError(`${ERROR_PREFIX}_NO_SERVICE_FOUND`, 'No service named \'%s\' has been added to this runtime.'),
+  NoEntryPointError: createError(`${ERROR_PREFIX}_NO_ENTRYPOINT`, 'No entrypoint had been deinfed.')
+}

package/lib/generator/runtime-generator.d.ts

@@ -0,0 +1,40 @@
+'use strict'
+
+import { BaseGenerator, BaseGeneratorOptions } from "@platformatic/generators"
+import { FileGenerator } from "@platformatic/generators/lib/file-generator"
+
+type Service = {
+  config: FileGenerator | BaseGenerator
+}
+type GeneratorMetadata = {
+  targetDirectory: string
+  env: KeyValue
+}
+
+type KeyValue = {
+  [key: string]: string
+}
+
+type RuntimeGeneratorOptions =  BaseGeneratorOptions & {
+  logLevel: string
+}
+
+class RuntimeGenerator extends BaseGenerator {
+  services: Service[]
+  entryPoint: Service
+  constructor(opts?: RuntimeGeneratorOptions)
+
+  async addService(service: Service, name: string): Promise<void>
+
+  setEntryPoint(entryPoint: string): void
+
+  setServicesDirectory(): void
+
+  setServicesConfig(configToOverride: object): void
+
+  getRuntimeEnv(): KeyValue
+  async writeServicesFiles(): Promise<GeneratorMetadata>
+}
+
+export default RuntimeGenerator
+export { RuntimeGenerator }

package/lib/generator/runtime-generator.js

@@ -0,0 +1,183 @@
+'use strict'
+const { BaseGenerator } = require('@platformatic/generators')
+const { NoEntryPointError, NoServiceNamedError } = require('./errors')
+const generateName = require('boring-name-generator')
+const { join } = require('node:path')
+const { envObjectToString } = require('@platformatic/generators/lib/utils')
+class RuntimeGenerator extends BaseGenerator {
+  constructor (opts) {
+    super(opts)
+    this.services = []
+    this.entryPoint = null
+  }
+
+  async addService (service, name) {
+    // ensure service config is correct
+    const originalConfig = service.config
+    const serviceName = name || generateName().dashed
+    const newConfig = {
+      ...originalConfig,
+      isRuntimeContext: true,
+      serviceName
+    }
+    // reset all files previously generated by the service
+    service.reset()
+    service.setConfig(newConfig)
+    this.services.push({
+      name: serviceName,
+      service
+    })
+
+    if (typeof service.setRuntime === 'function') {
+      service.setRuntime(this)
+    }
+  }
+
+  setEntryPoint (entryPoint) {
+    const service = this.services.find((svc) => svc.name === entryPoint)
+    if (!service) {
+      throw new NoServiceNamedError(entryPoint)
+    }
+    this.entryPoint = service
+  }
+
+  async generatePackageJson () {
+    return {
+      scripts: {
+        start: 'platformatic start',
+        test: 'node --test test/*/*.test.js'
+      },
+      devDependencies: {
+        fastify: `^${this.fastifyVersion}`
+      },
+      dependencies: {
+        platformatic: `^${this.platformaticVersion}`
+      },
+      engines: {
+        node: '^18.8.0 || >=20.6.0'
+      }
+    }
+  }
+
+  async _beforePrepare () {
+    this.setServicesDirectory()
+    this.setServicesConfigValues()
+    this.config.env = {
+      PLT_SERVER_HOSTNAME: '0.0.0.0',
+      PORT: this.config.port || 3042,
+      PLT_SERVER_LOGGER_LEVEL: this.config.logLevel || 'info',
+      ...this.config.env
+    }
+  }
+
+  setServicesConfigValues () {
+    this.services.forEach(({ service }) => {
+      if (!service.config) {
+        // set default config
+        service.setConfig()
+      }
+      service.config.typescript = this.config.typescript
+    })
+  }
+
+  async _getConfigFileContents () {
+    const config = {
+      $schema: `https://platformatic.dev/schemas/v${this.platformaticVersion}/runtime`,
+      entrypoint: this.entryPoint.name,
+      allowCycles: false,
+      hotReload: true,
+      autoload: {
+        path: 'services',
+        exclude: ['docs']
+      },
+      server: {
+        hostname: '{PLT_SERVER_HOSTNAME}',
+        port: '{PORT}',
+        logger: {
+          level: '{PLT_SERVER_LOGGER_LEVEL}'
+        }
+      }
+    }
+
+    return config
+  }
+
+  async _afterPrepare () {
+    if (!this.entryPoint) {
+      throw new NoEntryPointError()
+    }
+    const servicesEnv = await this.prepareServiceFiles()
+    this.config.env = {
+      ...this.config.env,
+      ...this.getRuntimeEnv(),
+      ...servicesEnv
+    }
+
+    this.addFile({
+      path: '',
+      file: '.env',
+      contents: envObjectToString(this.config.env)
+    })
+
+    return {
+      targetDirectory: this.targetDirectory,
+      env: servicesEnv
+    }
+  }
+
+  async writeFiles () {
+    await super.writeFiles()
+    for (const { service } of this.services) {
+      await service.writeFiles()
+    }
+  }
+
+  setServicesDirectory () {
+    this.services.forEach(({ service }) => {
+      if (!service.config) {
+        // set default config
+        service.setConfig()
+      }
+      service.setTargetDirectory(join(this.targetDirectory, 'services', service.config.serviceName))
+    })
+  }
+
+  setServicesConfig (configToOverride) {
+    this.services.forEach((service) => {
+      const originalConfig = service.config
+      service.setConfig({
+        ...originalConfig,
+        ...configToOverride
+      })
+    })
+  }
+
+  async prepareServiceFiles () {
+    let servicesEnv = {}
+    for (const svc of this.services) {
+      const svcEnv = await svc.service.prepare()
+      servicesEnv = {
+        ...servicesEnv,
+        ...svcEnv.env
+      }
+    }
+    return servicesEnv
+  }
+
+  getConfigFieldsDefinitions () {
+    return []
+  }
+
+  setConfigFields () {
+    // do nothing, makes no sense
+  }
+
+  getRuntimeEnv () {
+    return {
+      PORT: this.config.port
+    }
+  }
+}
+
+module.exports = RuntimeGenerator
+module.exports.RuntimeGenerator = RuntimeGenerator

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "1.12.1",
+  "version": "1.13.1",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -28,12 +28,13 @@
     "standard": "^17.1.0",
     "tsd": "^0.29.0",
     "typescript": "^5.2.2",
-    "@platformatic/sql-graphql": "1.12.1",
-    "@platformatic/sql-mapper": "1.12.1"
+    "@platformatic/sql-graphql": "1.13.1",
+    "@platformatic/sql-mapper": "1.13.1"
   },
   "dependencies": {
     "@fastify/error": "^3.4.0",
     "@hapi/topo": "^6.0.2",
+    "boring-name-generator": "^1.0.3",
     "close-with-grace": "^1.2.0",
     "commist": "^3.2.0",
     "debounce": "^2.0.0",
@@ -48,12 +49,13 @@
     "pino": "^8.16.0",
     "pino-pretty": "^10.2.3",
     "undici": "^5.26.3",
-    "@platformatic/composer": "1.12.1",
-    "@platformatic/service": "1.12.1",
-    "@platformatic/db": "1.12.1",
-    "@platformatic/config": "1.12.1",
-    "@platformatic/telemetry": "1.12.1",
-    "@platformatic/utils": "1.12.1"
+    "@platformatic/composer": "1.13.1",
+    "@platformatic/generators": "1.13.1",
+    "@platformatic/db": "1.13.1",
+    "@platformatic/service": "1.13.1",
+    "@platformatic/config": "1.13.1",
+    "@platformatic/telemetry": "1.13.1",
+    "@platformatic/utils": "1.13.1"
   },
   "standard": {
     "ignore": [