@platformatic/generators 1.14.4 → 1.15.1

package/lib/base-generator.d.ts

@@ -6,7 +6,7 @@ export namespace BaseGenerator {
     module: string
     inquirer?: object
   }
-  
+
   export type Env = {
     [key: string]: string | number | boolean
   }
@@ -14,13 +14,13 @@ export namespace BaseGenerator {
     [key: string]: string | number | undefined | null | boolean | object
   }
   type JSONValue =
-      | string
-      | number
-      | boolean
-      | { [x: string]: JSONValue }
-      | object
-      | Array<JSONValue>
-  
+    | string
+    | number
+    | boolean
+    | { [x: string]: JSONValue }
+    | object
+    | Array<JSONValue>
+
   type Dependency = {
     [key: string]: string
   }
@@ -34,7 +34,7 @@ export namespace BaseGenerator {
     hostname?: string
     plugin?: boolean
     dependencies?: Dependency
-    devDependencies?: Dependency  
+    devDependencies?: Dependency
     typescript?: boolean
     initGitRepository?: boolean
     staticWorkspaceGitHubActions?: boolean
@@ -44,12 +44,12 @@ export namespace BaseGenerator {
     serviceName?: string,
     envPrefix?: string
   }
-  
+
   type WhereClause = {
     before?: string
     after?: string
   }
-  
+
   type GeneratorMetadata = {
     targetDirectory: string
     env: KeyValue
@@ -59,7 +59,7 @@ export namespace BaseGenerator {
     label: string
     var: string
     default: string
-    type: 'number' | 'string' | 'boolean'
+    type: 'number' | 'string' | 'boolean' | 'path'
     configValue?: 'string'
 
   }
@@ -72,22 +72,22 @@ export namespace BaseGenerator {
     logger: BaseLogger
     platformaticVersion: string
     fastifyVersion: string
-    
+
     config: BaseGeneratorConfig
     questions: Array<object>
-  
+
     packages: PackageConfiguration[]
     constructor(opts?: BaseGeneratorOptions)
-  
+
     setConfig(config?: BaseGeneratorConfig): void
-    setEnv(env?: Env ): void
-  
+    setEnv(env?: Env): void
+
     getDefaultConfig(): JSONValue
-    getDefaultEnv(): Env 
-  
+    getDefaultEnv(): Env
+
     getFastifyVersion(): Promise<string>
     getPlatformaticVersion(): Promise<string>
-  
+
     addPackage(pkg: PackageDefinition): void
 
     prepare(): Promise<GeneratorMetadata>
@@ -95,7 +95,7 @@ export namespace BaseGenerator {
     addQuestion(question: any, where?: WhereClause): Promise<void>
     removeQuestion(variableName: string): void
     getTSConfig(): JSONValue
-    
+
     getConfigFieldsDefinitions(): ConfigFieldDefinition[]
     setConfigFields(fields: ConfigField[]): void
 

package/lib/base-generator.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const { readFile } = require('node:fs/promises')
-const { stripVersion, convertServiceNameToPrefix, addPrefixToEnv, extractEnvVariablesFromText } = require('./utils')
+const { stripVersion, convertServiceNameToPrefix, addPrefixToEnv, extractEnvVariablesFromText, getPackageConfigurationObject, PLT_ROOT } = require('./utils')
 const { join } = require('node:path')
 const { FileGenerator } = require('./file-generator')
 const { generateTests, generatePlugins } = require('./create-plugin')
@@ -203,16 +203,20 @@ class BaseGenerator extends FileGenerator {
   }
 
   checkEnvVariablesInConfigFile () {
+    const excludedEnvs = [PLT_ROOT]
     const configFileName = 'platformatic.json'
     const fileOjbect = this.getFileObject(configFileName)
     const envVars = extractEnvVariablesFromText(fileOjbect.contents)
     const envKeys = Object.keys(this.config.env)
     if (envVars.length > 0) {
-      envVars.forEach((ev) => {
+      for (const ev of envVars) {
+        if (excludedEnvs.includes(ev)) {
+          continue
+        }
         if (!envKeys.includes(ev)) {
           throw new MissingEnvVariable(ev, configFileName)
         }
-      })
+      }
     }
 
     return true
@@ -273,6 +277,33 @@ class BaseGenerator extends FileGenerator {
   async generateConfigFile () {
     const configFileName = 'platformatic.json'
     const contents = await this._getConfigFileContents()
+
+    // handle packages
+    if (this.packages.length > 0) {
+      if (!contents.plugins) {
+        contents.plugins = {}
+      }
+      contents.plugins.packages = this.packages.map((packageDefinition) => {
+        const packageConfigOutput = getPackageConfigurationObject(packageDefinition.options, this.config.serviceName)
+        if (Object.keys(packageConfigOutput.env).length > 0) {
+          const envForPackages = {}
+          Object.entries(packageConfigOutput.env).forEach((kv) => {
+            envForPackages[kv[0]] = kv[1]
+          })
+          if (this.config.isRuntimeContext) {
+            this.config.env = {
+              ...this.config.env,
+              ...addPrefixToEnv(envForPackages, this.config.envPrefix)
+            }
+          }
+        }
+        return {
+          name: packageDefinition.name,
+          options: packageConfigOutput.config
+        }
+      })
+    }
+
     this.addFile({
       path: '',
       file: configFileName,

package/lib/utils.d.ts

@@ -3,7 +3,7 @@ type Env = {
 }
 
 export type PackageConfiguration = {
-  type: 'number' | 'string' | 'boolean'
+  type: 'number' | 'string' | 'boolean' | 'path'
   path: string
   value: number | string | boolean
 }
@@ -17,4 +17,5 @@ export namespace GeneratorUtils {
   export function envObjectToString(env: Env): string
   export function extractEnvVariablesFromText(text: string): string[]
   export function getPackageConfigurationObject(config: PackageConfiguration[]): object
+  export const PLT_ROOT: string
 }

package/lib/utils.js

@@ -2,6 +2,8 @@
 
 const { mkdir } = require('node:fs/promises')
 const { WrongTypeError } = require('./errors')
+const { join } = require('node:path')
+const PLT_ROOT = 'PLT_ROOT'
 
 async function safeMkdir (dir) {
   try {
@@ -89,6 +91,7 @@ function getPackageConfigurationObject (config, serviceName = '') {
     props.forEach((prop, idx) => {
       if (idx === props.length - 1) {
         let value
+        let isPath = false
         switch (param.type) {
           case 'string' :
             value = param.value.toString()
@@ -99,6 +102,10 @@ function getPackageConfigurationObject (config, serviceName = '') {
           case 'boolean':
             value = (param.value === 'true')
             break
+          case 'path':
+            value = `${join(`{${PLT_ROOT}}`, param.value)}`
+            isPath = true
+            break
           default:
             throw new WrongTypeError(param.type)
         }
@@ -106,7 +113,13 @@ function getPackageConfigurationObject (config, serviceName = '') {
           current[prop] = value
         } else {
           const key = addPrefixToString(param.name, convertServiceNameToPrefix(serviceName))
-          current[prop] = `{${key}}`
+          // If it's a path, we need to add it to the env only the relative part of the path
+          if (isPath) {
+            current[prop] = `${join(`{${PLT_ROOT}}`, `{${key}}`)}`
+            value = param.value
+          } else {
+            current[prop] = `{${key}}`
+          }
           output.env[key] = value
         }
         current = output.config
@@ -128,5 +141,6 @@ module.exports = {
   envObjectToString,
   extractEnvVariablesFromText,
   safeMkdir,
-  stripVersion
+  stripVersion,
+  PLT_ROOT
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "1.14.4",
+  "version": "1.15.1",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],

package/test/base-generator.test.js

@@ -404,6 +404,171 @@ test('should add package', async () => {
   assert.deepEqual(bg.packages[0], packageDefinition)
 })
 
+test('support packages', async (t) => {
+  {
+    const svc = new BaseGenerator({
+      module: '@platformatic/service'
+    })
+    const packageDefinitions = [
+      {
+        name: '@fastify/compress',
+        options: [
+          {
+            path: 'threshold',
+            value: '1',
+            type: 'number'
+          },
+          {
+            path: 'foobar',
+            value: '123',
+            type: 'number',
+            name: 'FST_PLUGIN_STATIC_FOOBAR'
+          }
+        ]
+      }
+    ]
+    svc.setConfig({
+      isRuntimeContext: true,
+      serviceName: 'my-service'
+    })
+    svc.addPackage(packageDefinitions[0])
+    await svc.prepare()
+
+    const platformaticConfigFile = svc.getFileObject('platformatic.json')
+    const contents = JSON.parse(platformaticConfigFile.contents)
+
+    assert.deepEqual(contents.plugins, {
+      packages: [
+        {
+          name: '@fastify/compress',
+          options: {
+            threshold: 1,
+            foobar: '{PLT_MY_SERVICE_FST_PLUGIN_STATIC_FOOBAR}'
+          }
+        }
+      ]
+    })
+
+    assert.equal(svc.config.env.PLT_MY_SERVICE_FST_PLUGIN_STATIC_FOOBAR, 123)
+  }
+  {
+    // with standard platformatic plugin
+    const svc = new BaseGenerator({
+      module: '@platformatic/service'
+    })
+    svc.setConfig({
+      plugin: true
+    })
+    const packageDefinitions = [
+      {
+        name: '@fastify/compress',
+        options: [
+          {
+            path: 'threshold',
+            value: '1',
+            type: 'number'
+          }
+        ]
+      }
+    ]
+    svc.addPackage(packageDefinitions[0])
+    await svc.prepare()
+
+    const platformaticConfigFile = svc.getFileObject('platformatic.json')
+    const contents = JSON.parse(platformaticConfigFile.contents)
+
+    assert.deepEqual(contents.plugins, {
+      packages: [
+        {
+          name: '@fastify/compress',
+          options: {
+            threshold: 1
+          }
+        }
+      ]
+    })
+  }
+
+  {
+    // with relative path type but no name
+    const svc = new BaseGenerator({
+      module: '@platformatic/service'
+    })
+    svc.setConfig({
+      isRuntimeContext: true,
+      plugin: true
+    })
+    const packageDefinitions = [
+      {
+        name: '@fastify/static',
+        options: [
+          {
+            path: 'root',
+            value: 'public',
+            type: 'path'
+          }
+        ]
+      }
+    ]
+    svc.addPackage(packageDefinitions[0])
+    await svc.prepare()
+
+    const platformaticConfigFile = svc.getFileObject('platformatic.json')
+    const contents = JSON.parse(platformaticConfigFile.contents)
+
+    assert.deepEqual(contents.plugins, {
+      packages: [
+        {
+          name: '@fastify/static',
+          options: {
+            root: '{PLT_ROOT}/public'
+          }
+        }
+      ]
+    })
+  }
+  {
+    // with relative path type and name
+    const svc = new BaseGenerator({
+      module: '@platformatic/service'
+    })
+    svc.setConfig({
+      isRuntimeContext: true,
+      plugin: true,
+      serviceName: 'my-service'
+    })
+    const packageDefinitions = [
+      {
+        name: '@fastify/static',
+        options: [
+          {
+            path: 'root',
+            value: 'public',
+            type: 'path',
+            name: 'FST_PLUGIN_STATIC_ROOT'
+          }
+        ]
+      }
+    ]
+    svc.addPackage(packageDefinitions[0])
+    await svc.prepare()
+
+    const platformaticConfigFile = svc.getFileObject('platformatic.json')
+    const contents = JSON.parse(platformaticConfigFile.contents)
+
+    assert.deepEqual(contents.plugins, {
+      packages: [
+        {
+          name: '@fastify/static',
+          options: {
+            root: '{PLT_ROOT}/{PLT_MY_SERVICE_FST_PLUGIN_STATIC_ROOT}'
+          }
+        }
+      ]
+    })
+  }
+})
+
 describe('runtime context', () => {
   test('should set config.envPrefix correctly', async (t) => {
     const bg = new BaseGenerator({