@platformatic/generators 2.67.0-alpha.1 → 2.67.0

package/index.js

@@ -1,10 +1,13 @@
 'use strict'
 
 const { BaseGenerator } = require('./lib/base-generator')
+const { ImportGenerator } = require('./lib/import-generator')
 const { generateTests } = require('./lib/create-plugin')
 const utils = require('./lib/utils')
+
 module.exports = {
   BaseGenerator,
+  ImportGenerator,
   generateTests,
-  ...utils,
+  ...utils
 }

package/lib/base-generator.js

@@ -8,7 +8,7 @@ const {
   getPackageConfigurationObject,
   PLT_ROOT,
   getLatestNpmVersion,
-  stripVersion,
+  stripVersion
 } = require('./utils')
 const { join } = require('node:path')
 const { FileGenerator } = require('./file-generator')
@@ -20,11 +20,11 @@ const { flattenObject } = require('./utils')
 const { envStringToObject } = require('./utils')
 /* c8 ignore start */
 const fakeLogger = {
-  info: () => { },
-  warn: () => { },
-  debug: () => { },
-  trace: () => { },
-  error: () => { },
+  info: () => {},
+  warn: () => {},
+  debug: () => {},
+  trace: () => {},
+  error: () => {}
 }
 /* c8 ignore start */
 
@@ -61,7 +61,7 @@ class BaseGenerator extends FileGenerator {
       envPrefix: '',
       env: {},
       defaultEnv: {},
-      isUpdating: false,
+      isUpdating: false
     }
   }
 
@@ -72,9 +72,11 @@ class BaseGenerator extends FileGenerator {
   setConfigFields (fields) {
     const availableConfigFields = this.getConfigFieldsDefinitions()
     function shouldHandleConfigField (field) {
-      return availableConfigFields.filter((f) => {
-        return f.configValue === field.configValue && f.var === field.var
-      }).length > 0
+      return (
+        availableConfigFields.filter(f => {
+          return f.configValue === field.configValue && f.var === field.var
+        }).length > 0
+      )
     }
     for (const field of fields) {
       if (shouldHandleConfigField(field)) {
@@ -138,7 +140,7 @@ class BaseGenerator extends FileGenerator {
     this.config = {
       ...this.getDefaultConfig(),
       ...oldConfig,
-      ...config,
+      ...config
     }
 
     if (this.config.isRuntimeContext) {
@@ -164,7 +166,7 @@ class BaseGenerator extends FileGenerator {
       const newConfig = await this.inquirer.prompt(this.questions)
       this.setConfig({
         ...this.config,
-        ...newConfig,
+        ...newConfig
       })
     }
   }
@@ -191,7 +193,7 @@ class BaseGenerator extends FileGenerator {
         this.addFile({
           path: '',
           file: this.runtimeConfig,
-          contents: JSON.stringify(currentConfigFile, null, 2),
+          contents: JSON.stringify(currentConfigFile, null, 2)
         })
       } else {
         await this.getFastifyVersion()
@@ -204,7 +206,7 @@ class BaseGenerator extends FileGenerator {
         this.addFile({
           path: '',
           file: 'package.json',
-          contents: JSON.stringify(template, null, 2),
+          contents: JSON.stringify(template, null, 2)
         })
 
         await this.generateConfigFile()
@@ -216,7 +218,7 @@ class BaseGenerator extends FileGenerator {
           this.addFile({
             path: '',
             file: 'tsconfig.json',
-            contents: JSON.stringify(this.getTsConfig(), null, 2),
+            contents: JSON.stringify(this.getTsConfig(), null, 2)
           })
         }
 
@@ -237,7 +239,7 @@ class BaseGenerator extends FileGenerator {
       }
       return {
         targetDirectory: this.targetDirectory,
-        env: this.config.env,
+        env: this.config.env
       }
     } catch (err) {
       if (err.code?.startsWith('PLT_GEN')) {
@@ -282,15 +284,15 @@ class BaseGenerator extends FileGenerator {
         incremental: true,
         strict: true,
         outDir: 'dist',
-        skipLibCheck: true,
+        skipLibCheck: true
       },
       watchOptions: {
         watchFile: 'fixedPollingInterval',
         watchDirectory: 'fixedPollingInterval',
         fallbackPolling: 'dynamicPriority',
         synchronousWatchDirectory: true,
-        excludeDirectories: ['**/node_modules', 'dist'],
-      },
+        excludeDirectories: ['**/node_modules', 'dist']
+      }
     }
   }
 
@@ -301,7 +303,7 @@ class BaseGenerator extends FileGenerator {
         this.questions.push({
           type: 'input',
           name: 'targetDirectory',
-          message: 'Where would you like to create your project?',
+          message: 'Where would you like to create your project?'
         })
       }
 
@@ -337,18 +339,18 @@ class BaseGenerator extends FileGenerator {
       if (!contents.plugins) {
         contents.plugins = {}
       }
-      contents.plugins.packages = this.packages.map((packageDefinition) => {
+      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) => {
+          Object.entries(packageConfigOutput.env).forEach(kv => {
             envForPackages[kv[0]] = kv[1]
           })
           this.addEnvVars(envForPackages)
         }
         return {
           name: packageDefinition.name,
-          options: packageConfigOutput.config,
+          options: packageConfigOutput.config
         }
       })
     }
@@ -356,8 +358,10 @@ class BaseGenerator extends FileGenerator {
     this.addFile({
       path: '',
       file: configFileName,
-      contents: JSON.stringify(contents, null, 2),
+      contents: JSON.stringify(contents, null, 2)
     })
+
+    return contents
   }
 
   /**
@@ -388,23 +392,24 @@ class BaseGenerator extends FileGenerator {
       name: `${this.config.serviceName}`,
       scripts: {
         start: 'platformatic start',
-        test: 'borp',
+        test: 'borp'
       },
       devDependencies: {
         fastify: `^${this.fastifyVersion}`,
         borp: `${this.pkgData.devDependencies.borp}`,
-        ...this.config.devDependencies,
+        ...this.config.devDependencies
       },
       dependencies: {
-        ...this.config.dependencies,
+        ...this.config.dependencies
       },
       engines: {
-        node: '^22.14.0 || ^20.6.0',
-      },
+        node: '^22.14.0 || ^20.6.0'
+      }
     }
 
     if (this.config.typescript) {
-      const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', 'package.json'), 'utf-8')).devDependencies.typescript
+      const typescriptVersion = JSON.parse(await readFile(join(__dirname, '..', 'package.json'), 'utf-8'))
+        .devDependencies.typescript
       template.scripts.clean = 'rm -fr ./dist'
       template.scripts.build = 'platformatic compile'
       template.devDependencies.typescript = typescriptVersion
@@ -413,29 +418,35 @@ class BaseGenerator extends FileGenerator {
   }
 
   async generateEnv () {
-    if (!this.config.isRuntimeContext) {
-      this.addFile({
-        path: '',
-        file: '.env',
-        contents: serializeEnvVars(this.config.env),
-      })
+    if (this.config.isRuntimeContext) {
+      return
+    }
 
-      const emptyEnvVars = {}
-      for (const envVarName of Object.keys(this.config.env)) {
-        if (!this.config.defaultEnv[envVarName]) {
-          emptyEnvVars[envVarName] = ''
-        }
+    const serializedEnv = serializeEnvVars(this.config.env)
+
+    this.addFile({
+      path: '',
+      file: '.env',
+      contents: serializedEnv
+    })
+
+    const emptyEnvVars = {}
+    for (const envVarName of Object.keys(this.config.env)) {
+      if (!this.config.defaultEnv[envVarName]) {
+        emptyEnvVars[envVarName] = ''
       }
+    }
 
-      this.addFile({
-        path: '',
-        file: '.env.sample',
-        contents: serializeEnvVars({
-          ...this.config.defaultEnv,
-          ...emptyEnvVars,
-        }),
+    this.addFile({
+      path: '',
+      file: '.env.sample',
+      contents: serializeEnvVars({
+        ...this.config.defaultEnv,
+        ...emptyEnvVars
       })
-    }
+    })
+
+    return serializedEnv
   }
 
   async run () {
@@ -460,7 +471,9 @@ class BaseGenerator extends FileGenerator {
   async loadFromDir (serviceName, runtimeRootPath) {
     const runtimePkgConfigFileData = JSON.parse(await readFile(join(runtimeRootPath, this.runtimeConfig), 'utf-8'))
     const servicesPath = runtimePkgConfigFileData.autoload.path
-    const servicePkgJsonFileData = JSON.parse(await readFile(join(runtimeRootPath, servicesPath, serviceName, 'platformatic.json'), 'utf-8'))
+    const servicePkgJsonFileData = JSON.parse(
+      await readFile(join(runtimeRootPath, servicesPath, serviceName, 'platformatic.json'), 'utf-8')
+    )
     const runtimeEnv = envStringToObject(await readFile(join(runtimeRootPath, '.env'), 'utf-8'))
     const serviceNamePrefix = convertServiceNameToPrefix(serviceName)
     const plugins = []
@@ -469,7 +482,7 @@ class BaseGenerator extends FileGenerator {
         const flattened = flattenObject(pkg)
         const output = {
           name: flattened.name,
-          options: [],
+          options: []
         }
         if (pkg.options) {
           Object.entries(flattened)
@@ -481,7 +494,7 @@ class BaseGenerator extends FileGenerator {
                 name: serviceEnvVarKey,
                 path: key.replace('options.', ''),
                 type: 'string',
-                value: runtimeEnv[runtimeEnvVarKey],
+                value: runtimeEnv[runtimeEnvVarKey]
               }
               output.options.push(option)
             })
@@ -495,16 +508,18 @@ class BaseGenerator extends FileGenerator {
       name: serviceName,
       template: getServiceTemplateFromSchemaUrl(servicePkgJsonFileData.$schema),
       fields: [],
-      plugins,
+      plugins
     }
   }
 
   // implement in the subclass
   /* c8 ignore next 1 */
-  async postInstallActions () { }
-  async _beforePrepare () { }
-  async _afterPrepare () { }
-  async _getConfigFileContents () { return {} }
+  async postInstallActions () {}
+  async _beforePrepare () {}
+  async _afterPrepare () {}
+  async _getConfigFileContents () {
+    return {}
+  }
 }
 
 function serializeEnvVars (envVars) {

package/lib/file-generator.js

@@ -1,6 +1,6 @@
 'use strict'
 const { createDirectory } = require('@platformatic/utils')
-const { join } = require('node:path')
+const { dirname, join, isAbsolute } = require('node:path')
 const { writeFile, readFile } = require('node:fs/promises')
 
 /* c8 ignore start */
@@ -9,7 +9,7 @@ const fakeLogger = {
   warn: () => {},
   debug: () => {},
   trace: () => {},
-  error: () => {},
+  error: () => {}
 }
 /* c8 ignore start */
 
@@ -31,15 +31,16 @@ class FileGenerator {
     return this.getFileObject(file, path)
   }
 
-  addFile ({ path, file, contents, options = {} }) {
+  addFile ({ path, file, contents, options = {}, tags }) {
     const fileObject = this.getFileObject(file, path)
     if (path.startsWith('/')) {
       path = path.substring(1)
     }
     if (fileObject) {
       fileObject.contents = contents
+      fileObject.tags = tags ?? []
     } else {
-      this.files.push({ path, file, contents, options })
+      this.files.push({ path, file, contents, options, tags: tags ?? [] })
     }
   }
 
@@ -64,26 +65,32 @@ class FileGenerator {
       if (fileToWrite.contents.length === 0 && !fileToWrite.file.match(/^\..+keep$/)) {
         continue
       }
-      const baseDir = join(this.targetDirectory, fileToWrite.path)
-      if (fileToWrite.path !== '') {
-        await createDirectory(baseDir)
+
+      let fullFilePath = join(fileToWrite.path, fileToWrite.file)
+
+      if (!isAbsolute(fullFilePath)) {
+        fullFilePath = join(this.targetDirectory, fullFilePath)
       }
-      const fullFilePath = join(baseDir, fileToWrite.file)
+
+      await createDirectory(dirname(fullFilePath))
       await writeFile(fullFilePath, fileToWrite.contents, fileToWrite.options)
+
       this.logger.info(`${fullFilePath} written!`)
     }
   }
 
   getFileObject (name, path = '') {
-    const output = this.files.find((file) => {
+    const output = this.files.find(file => {
       return file.path === path && file.file === name
     })
-    if (!output) { return null }
+    if (!output) {
+      return null
+    }
     return output
   }
 
   listFiles () {
-    return this.files.map((fileObject) => {
+    return this.files.map(fileObject => {
       return join(fileObject.path, fileObject.file)
     })
   }

package/lib/import-generator.js

@@ -0,0 +1,230 @@
+'use strict'
+
+const { findConfigurationFile } = require('@platformatic/config')
+const { safeRemove } = require('@platformatic/utils')
+const { glob } = require('glob')
+const { BaseGenerator } = require('./base-generator')
+const { spawnSync } = require('node:child_process')
+const { stat, readFile } = require('node:fs/promises')
+const { join, dirname } = require('node:path')
+
+class ImportGenerator extends BaseGenerator {
+  constructor (options = {}) {
+    const { serviceName, module, version, parent: runtime, ...opts } = options
+    super({ ...opts, module })
+
+    this.runtime = runtime
+    this.setConfig({
+      serviceName,
+      servicePathEnvName: `PLT_SERVICE_${serviceName.toUpperCase().replaceAll(/[^A-Z0-9_]/g, '_')}_PATH`,
+      module,
+      version
+    })
+  }
+
+  async prepareQuestions () {
+    await super.prepareQuestions()
+
+    this.questions.push({
+      type: 'input',
+      name: 'applicationPath',
+      message: 'Where is your application located?',
+      async validate (value) {
+        if (value.length === 0) {
+          return 'Please enter a path'
+        }
+
+        try {
+          const pathStat = await stat(value)
+
+          if (!pathStat?.isDirectory()) {
+            return 'Please enter a valid path'
+          }
+        } catch {
+          return 'Please enter a valid path'
+        }
+
+        return true
+      }
+    })
+
+    this.questions.push({
+      type: 'list',
+      name: 'operation',
+      message: 'Do you want to import or copy your application?',
+      default: 'import',
+      choices: [
+        { name: 'import', value: 'import' },
+        { name: 'copy', value: 'copy' }
+      ]
+    })
+  }
+
+  // We can't use prepare as it is not invoked from the runtime when dealing with existing applications
+  /* c8 ignore next 3 - Invoked from base-generator */
+  async prepare () {
+    return { targetDirectory: this.targetDirectory, env: this.config.env }
+  }
+
+  async _beforeWriteFiles (runtime) {
+    const { module: pkg, version, applicationPath: path } = this.config
+
+    const packageJsonPath = join(path, 'package.json')
+
+    if (this.config.operation === 'copy') {
+      await this.#copy(path)
+      await this.#generateConfigFile(path, '')
+      await this.#updatePackageJson(packageJsonPath, 'package.json', pkg, version)
+    } else {
+      await this.#detectGitUrl(path)
+      await this.#generateConfigFile(path, path)
+
+      await this.#updatePackageJson(packageJsonPath, packageJsonPath, pkg, version)
+      await this.#updateRuntime(runtime)
+    }
+  }
+
+  async _afterWriteFiles (runtime) {
+    // No need for an empty folder in the services folder
+    if (this.config.operation === 'import') {
+      await safeRemove(join(runtime.servicesBasePath, this.config.serviceName))
+    }
+  }
+
+  async #detectGitUrl (path) {
+    let url
+
+    // First of all, determine if there is a git repository in the application path
+    // Detect if there is a git folder and eventually get the remote
+    for (const candidate of ['origin', 'upstream']) {
+      try {
+        const result = spawnSync('git', ['remote', 'get-url', candidate], { cwd: path })
+
+        /* c8 ignore next 3 - Hard to test */
+        if (result.error || result.status !== 0) {
+          continue
+        }
+
+        url = result.stdout.toString().trim()
+        break
+        /* c8 ignore next 3 - Hard to test */
+      } catch (e) {
+        // No-op
+      }
+    }
+
+    this.setConfig({ gitUrl: url })
+    return url
+  }
+
+  async #generateConfigFile (originalPath, updatedPath) {
+    // Determine if there is a watt.json file in the application path - If it's missing, insert one
+    // For import it means we don't update  the file, for copy it means it was already copied in #copy.
+    const existingConfig = await findConfigurationFile(originalPath)
+
+    if (existingConfig) {
+      return
+    }
+
+    const { module: pkg, version } = this.config
+
+    if (pkg.startsWith('@platformatic/')) {
+      this.addFile({
+        path: '',
+        file: join(updatedPath, this.runtimeConfig),
+        contents: JSON.stringify({ $schema: `https://schemas.platformatic.dev/${pkg}/${version}.json` }, null, 2)
+      })
+    } else {
+      this.addFile({
+        path: '',
+        file: join(updatedPath, this.runtimeConfig),
+        contents: JSON.stringify({ module: pkg }, null, 2)
+      })
+    }
+  }
+
+  async #updatePackageJson (originalPath, updatedPath, pkg, version) {
+    // Add the module to the package.json dependencies
+    let packageJson = {}
+
+    try {
+      packageJson = JSON.parse(await readFile(originalPath, 'utf-8'))
+    } catch (e) {
+      // No-op, we will create a new package.json
+    }
+
+    packageJson.dependencies ??= {}
+    packageJson.dependencies[pkg] = `^${version}`
+    if (packageJson.devDependencies?.[pkg]) {
+      packageJson.devDependencies[pkg] = undefined
+    }
+
+    this.addFile({ path: '', file: updatedPath, contents: JSON.stringify(packageJson, null, 2) })
+  }
+
+  async #updateRuntime (runtime) {
+    const configObject = runtime.getRuntimeConfigFileObject()
+    /* c8 ignore next - else */
+    const config = JSON.parse(configObject?.contents ?? '{}')
+    const envObject = runtime.getRuntimeEnvFileObject()
+    /* c8 ignore next - else */
+    let env = envObject?.contents ?? ''
+
+    // Find which key is being used for the manual services
+    let key
+    for (const candidate of new Set([runtime.servicesFolder, 'web', 'services'])) {
+      if (Array.isArray(config[candidate])) {
+        key = candidate
+        break
+      }
+    }
+
+    /* c8 ignore next - else */
+    key ??= runtime.servicesFolder ?? 'services'
+    const services = config[key] ?? []
+
+    if (!services.some(service => service.id === this.config.serviceName)) {
+      services.push({
+        id: this.config.serviceName,
+        path: `{${this.config.servicePathEnvName}}`,
+        url: this.config.gitUrl
+      })
+    }
+
+    config[key] = services
+
+    if (env.length > 0) {
+      env += '\n'
+    }
+    env += `${this.config.servicePathEnvName}=${this.config.applicationPath}`
+
+    runtime.updateRuntimeConfig(config)
+    runtime.updateRuntimeEnv(env)
+  }
+
+  async #copy (root) {
+    const files = await glob('**/*', { cwd: root, dot: true, ignore: ['node_modules/**'], withFileTypes: true })
+
+    for (const file of files) {
+      if (file.isDirectory()) {
+        continue
+      }
+
+      /* c8 ignore next 6 */
+      let path = dirname(file.relative())
+      if (path === '.') {
+        path = ''
+      } else if (path.startsWith('./')) {
+        path = path.substring(2)
+      }
+
+      this.addFile({
+        path,
+        file: file.name,
+        contents: await readFile(file.fullpath())
+      })
+    }
+  }
+}
+
+module.exports = { ImportGenerator }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/generators",
-  "version": "2.67.0-alpha.1",
+  "version": "2.67.0",
   "description": "Main classes and utils for generators.",
   "main": "index.js",
   "keywords": [],
@@ -9,10 +9,12 @@
   "dependencies": {
     "@fastify/error": "^4.0.0",
     "change-case-all": "^2.1.0",
+    "execa": "^9.6.0",
     "fastify": "^5.0.0",
     "pino": "^9.0.0",
     "undici": "^7.0.0",
-    "@platformatic/utils": "2.67.0-alpha.1"
+    "@platformatic/config": "2.67.0",
+    "@platformatic/utils": "2.67.0"
   },
   "devDependencies": {
     "@types/inquirer": "^9.0.7",