create-platformatic 0.47.6 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-platformatic",
-  "version": "0.47.6",
+  "version": "1.0.0",
   "description": "Create platformatic-db interactive tool",
   "repository": {
     "type": "git",
@@ -34,7 +34,7 @@
     "semver": "^7.5.1",
     "undici": "^5.22.1",
     "which": "^3.0.1",
-    "@platformatic/config": "0.47.6"
+    "@platformatic/config": "1.0.0"
   },
   "devDependencies": {
     "ajv": "^8.12.0",
@@ -47,8 +47,8 @@
     "tap": "^16.3.6",
     "typescript": "~5.2.0",
     "yaml": "^2.3.1",
-    "@platformatic/db": "0.47.6",
-    "@platformatic/service": "0.47.6"
+    "@platformatic/service": "1.0.0",
+    "@platformatic/db": "1.0.0"
   },
   "scripts": {
     "test": "standard | snazzy && cross-env NODE_OPTIONS=\"--loader=esmock --no-warnings\" c8 tap --no-coverage test/*test.mjs test/*/*test.mjs",

package/src/composer/create-composer-cli.mjs

@@ -67,13 +67,19 @@ const createPlatformaticComposer = async (_args, opts) => {
   const projectDir = opts.dir || await askDir(logger, '.')
   const isRuntimeContext = opts.isRuntimeContext || false
 
-  const toAsk = [getPort(args.port)]
+  const toAsk = []
+
+  if (!isRuntimeContext) {
+    toAsk.push(getPort(args.port))
+  }
 
   if (isRuntimeContext) {
     const servicesNames = opts.runtimeContext.servicesNames.filter(
       (serviceName) => serviceName !== opts.serviceName
     )
-    toAsk.push(getServicesToCompose(servicesNames))
+    if (servicesNames.length > 0) {
+      toAsk.push(getServicesToCompose(servicesNames))
+    }
   }
 
   if (!opts.skipPackageJson) {
@@ -90,18 +96,17 @@ const createPlatformaticComposer = async (_args, opts) => {
   await mkdir(projectDir, { recursive: true })
 
   const params = {
+    isRuntimeContext,
     hostname: args.hostname,
     port,
-    isRuntime: opts.isRuntime
+    servicesToCompose
   }
 
   const env = await createComposer(
     params,
     logger,
     projectDir,
-    version,
-    isRuntimeContext,
-    servicesToCompose
+    version
   )
 
   const fastifyVersion = await getDependencyVersion('fastify')

package/src/composer/create-composer.mjs

@@ -3,16 +3,9 @@ import { findComposerConfigFile, isFileAccessible } from '../utils.mjs'
 import { join } from 'path'
 import * as desm from 'desm'
 
-function generateConfig (version, isRuntimeContext, servicesToCompose) {
+function generateConfig (isRuntimeContext, version, servicesToCompose) {
   const config = {
     $schema: `https://platformatic.dev/schemas/v${version}/composer`,
-    server: {
-      hostname: '{PLT_SERVER_HOSTNAME}',
-      port: '{PORT}',
-      logger: {
-        level: '{PLT_SERVER_LOGGER_LEVEL}'
-      }
-    },
     composer: {
       services: [{
         id: 'example',
@@ -26,6 +19,16 @@ function generateConfig (version, isRuntimeContext, servicesToCompose) {
     watch: true
   }
 
+  if (!isRuntimeContext) {
+    config.server = {
+      hostname: '{PLT_SERVER_HOSTNAME}',
+      port: '{PORT}',
+      logger: {
+        level: '{PLT_SERVER_LOGGER_LEVEL}'
+      }
+    }
+  }
+
   if (isRuntimeContext) {
     config.composer.services = servicesToCompose.map((serviceName) => {
       return {
@@ -42,14 +45,13 @@ function generateConfig (version, isRuntimeContext, servicesToCompose) {
 }
 
 function generateEnv (isRuntimeContext, hostname, port) {
-  let env = `\
-PLT_SERVER_HOSTNAME=${hostname}
-PORT=${port}
-PLT_SERVER_LOGGER_LEVEL=info
-`
+  let env = ''
 
   if (!isRuntimeContext) {
     env += `\
+PLT_SERVER_HOSTNAME=${hostname}
+PORT=${port}
+PLT_SERVER_LOGGER_LEVEL=info
 PLT_EXAMPLE_ORIGIN=
 `
   }
@@ -58,13 +60,13 @@ PLT_EXAMPLE_ORIGIN=
 }
 
 async function createComposer (
-  { hostname, port },
+  params,
   logger,
   currentDir = process.cwd(),
-  version,
-  isRuntimeContext = false,
-  servicesToCompose = []
+  version
 ) {
+  const { isRuntimeContext, hostname, port, servicesToCompose = [] } = params
+
   if (!version) {
     const pkg = await readFile(desm.join(import.meta.url, '..', '..', 'package.json'))
     version = JSON.parse(pkg).version
@@ -72,7 +74,7 @@ async function createComposer (
   const accessibleConfigFilename = await findComposerConfigFile(currentDir)
 
   if (accessibleConfigFilename === undefined) {
-    const config = generateConfig(version, isRuntimeContext, servicesToCompose)
+    const config = generateConfig(isRuntimeContext, version, servicesToCompose)
     await writeFile(join(currentDir, 'platformatic.composer.json'), JSON.stringify(config, null, 2))
     logger.info('Configuration file platformatic.composer.json successfully created.')
 

package/src/db/create-db-cli.mjs

@@ -55,10 +55,7 @@ export function parseDBArgs (_args) {
     default: {
       hostname: '127.0.0.1',
       database: 'sqlite',
-      migrations: 'migrations',
-      plugin: true,
-      types: true,
-      typescript: false
+      migrations: 'migrations'
     },
     alias: {
       h: 'hostname',
@@ -83,6 +80,7 @@ const createPlatformaticDB = async (_args, opts) => {
   const version = await getVersion()
   const pkgManager = getPkgManager()
   const projectDir = opts.dir || await askDir(logger, '.')
+  const isRuntimeContext = opts.isRuntimeContext || false
 
   const { database } = await inquirer.prompt({
     type: 'list',
@@ -125,23 +123,28 @@ const createPlatformaticDB = async (_args, opts) => {
       break
     }
   }
-
-  const wizardOptions = await inquirer.prompt([{
+  const wizardPrompts = [{
     type: 'list',
     name: 'defaultMigrations',
     message: 'Do you want to create default migrations?',
     default: true,
     choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-  }, {
-    type: 'list',
-    name: 'generatePlugin',
-    message: 'Do you want to create a plugin?',
-    default: args.plugin,
-    choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
-  },
-  getUseTypescript(args.typescript),
-  getPort(args.port)
-  ])
+  }]
+
+  if (args.plugin === false) {
+    wizardPrompts.push({
+      type: 'list',
+      name: 'generatePlugin',
+      message: 'Do you want to create a plugin?',
+      default: true,
+      choices: [{ name: 'yes', value: true }, { name: 'no', value: false }]
+    })
+  }
+  const wizardOptions = await inquirer.prompt(wizardPrompts, getUseTypescript(args.typescript))
+  if (!isRuntimeContext) {
+    const { port } = await inquirer.prompt([getPort(args.port)])
+    wizardOptions.port = port
+  }
 
   // Create the project directory
   await mkdir(projectDir, { recursive: true })
@@ -151,6 +154,7 @@ const createPlatformaticDB = async (_args, opts) => {
   const useTypes = args.types || generatePlugin // we set this always to true if we want to generate a plugin
 
   const params = {
+    isRuntimeContext,
     hostname: args.hostname,
     port: wizardOptions.port,
     database,
@@ -158,8 +162,7 @@ const createPlatformaticDB = async (_args, opts) => {
     migrations: wizardOptions.defaultMigrations ? args.migrations : '',
     plugin: generatePlugin,
     types: useTypes,
-    typescript: useTypescript,
-    isRuntime: opts.isRuntime
+    typescript: useTypescript
   }
 
   const env = await createDB(params, logger, projectDir, version)

package/src/db/create-db.mjs

@@ -249,16 +249,9 @@ test('movies', async (t) => {
 })
 `
 
-function generateConfig (migrations, plugin, types, typescript, version) {
+function generateConfig (isRuntimeContext, migrations, plugin, types, typescript, version) {
   const config = {
     $schema: `https://platformatic.dev/schemas/v${version}/db`,
-    server: {
-      hostname: '{PLT_SERVER_HOSTNAME}',
-      port: '{PORT}',
-      logger: {
-        level: '{PLT_SERVER_LOGGER_LEVEL}'
-      }
-    },
     db: {
       connectionString: '{DATABASE_URL}',
       graphql: true,
@@ -270,6 +263,16 @@ function generateConfig (migrations, plugin, types, typescript, version) {
     }
   }
 
+  if (!isRuntimeContext) {
+    config.server = {
+      hostname: '{PLT_SERVER_HOSTNAME}',
+      port: '{PORT}',
+      logger: {
+        level: '{PLT_SERVER_LOGGER_LEVEL}'
+      }
+    }
+  }
+
   if (migrations) {
     config.migrations = {
       dir: migrations
@@ -300,20 +303,27 @@ function generateConfig (migrations, plugin, types, typescript, version) {
   return config
 }
 
-function generateEnv (hostname, port, connectionString, typescript) {
+function generateEnv (isRuntimeContext, hostname, port, connectionString, typescript) {
   let env = `\
+DATABASE_URL=${connectionString}
+
+`
+
+  if (!isRuntimeContext) {
+    env += `\
 PLT_SERVER_HOSTNAME=${hostname}
 PORT=${port}
 PLT_SERVER_LOGGER_LEVEL=info
-DATABASE_URL=${connectionString}
-`
+
+  `
+  }
 
   if (typescript === true) {
     env += `\
-
 # Set to false to disable automatic typescript compilation.
 # Changing this setting is needed for production
 PLT_TYPESCRIPT=true
+
 `
   }
 
@@ -324,18 +334,31 @@ export function getConnectionString (database) {
   return connectionStrings[database]
 }
 
-export async function createDB ({ hostname, database = 'sqlite', port, migrations = 'migrations', plugin = true, types = true, typescript = false, connectionString }, logger, currentDir, version) {
+export async function createDB (params, logger, currentDir, version) {
+  let {
+    isRuntimeContext,
+    hostname,
+    port,
+    database = 'sqlite',
+    migrations = 'migrations',
+    plugin = true,
+    types = true,
+    typescript = false,
+    connectionString
+  } = params
+
   connectionString = connectionString || getConnectionString(database)
   const createMigrations = !!migrations // If we don't define a migrations folder, we don't create it
   const accessibleConfigFilename = await findDBConfigFile(currentDir)
   if (accessibleConfigFilename === undefined) {
-    const config = generateConfig(migrations, plugin, types, typescript, version)
+    const config = generateConfig(isRuntimeContext, migrations, plugin, types, typescript, version)
     await writeFile(join(currentDir, 'platformatic.db.json'), JSON.stringify(config, null, 2))
     logger.info('Configuration file platformatic.db.json successfully created.')
-    const env = generateEnv(hostname, port, connectionString, typescript)
+    const env = generateEnv(isRuntimeContext, hostname, port, connectionString, typescript)
+    const envSample = generateEnv(isRuntimeContext, hostname, port, getConnectionString(database), typescript)
     const envFileExists = await isFileAccessible('.env', currentDir)
     await appendFile(join(currentDir, '.env'), env)
-    await writeFile(join(currentDir, '.env.sample'), generateEnv(hostname, port, getConnectionString(database), typescript))
+    await writeFile(join(currentDir, '.env.sample'), envSample)
     /* c8 ignore next 5 */
     if (envFileExists) {
       logger.info('Environment file .env found, appending new environment variables to existing .env file.')

package/src/runtime/create-runtime-cli.mjs

@@ -12,7 +12,7 @@ import ora from 'ora'
 import createRuntime from './create-runtime.mjs'
 import askDir from '../ask-dir.mjs'
 import { askDynamicWorkspaceCreateGHAction, askStaticWorkspaceGHAction } from '../ghaction.mjs'
-import { getOverwriteReadme, getRunPackageManagerInstall } from '../cli-options.mjs'
+import { getPort, getOverwriteReadme, getRunPackageManagerInstall } from '../cli-options.mjs'
 import generateName from 'boring-name-generator'
 import { chooseKind } from '../index.mjs'
 
@@ -112,7 +112,15 @@ export async function createPlatformaticRuntime (_args) {
     entrypoint = names[0]
   }
 
-  const env = await createRuntime(logger, projectDir, version, servicesDir, entrypoint)
+  const { port: entrypointPort } = await inquirer.prompt([getPort()])
+
+  const params = {
+    servicesDir,
+    entrypoint,
+    entrypointPort
+  }
+
+  const env = await createRuntime(params, logger, projectDir, version)
 
   await askStaticWorkspaceGHAction(logger, env, 'service', false, projectDir)
   await askDynamicWorkspaceCreateGHAction(logger, env, 'service', false, projectDir)

package/src/runtime/create-runtime.mjs

@@ -1,5 +1,5 @@
-import { readFile, readdir, stat, unlink, writeFile } from 'fs/promises'
-import { findRuntimeConfigFile } from '../utils.mjs'
+import { readFile, appendFile, writeFile } from 'fs/promises'
+import { findConfigFile, findRuntimeConfigFile } from '../utils.mjs'
 import { join, relative, isAbsolute } from 'path'
 import * as desm from 'desm'
 
@@ -18,7 +18,9 @@ function generateConfig (version, path, entrypoint) {
   return config
 }
 
-async function createRuntime (logger, currentDir = process.cwd(), version, servicesDir, entrypoint) {
+async function createRuntime (params, logger, currentDir = process.cwd(), version) {
+  const { servicesDir, entrypoint, entrypointPort } = params
+
   if (!version) {
     const pkg = await readFile(desm.join(import.meta.url, '..', '..', 'package.json'))
     version = JSON.parse(pkg).version
@@ -33,83 +35,50 @@ async function createRuntime (logger, currentDir = process.cwd(), version, servi
   } else {
     logger.info(`Configuration file ${accessibleConfigFilename} found, skipping creation of configuration file.`)
   }
-  if (servicesDir) {
-    const servicesDirFullPath = isAbsolute(servicesDir) ? servicesDir : join(currentDir, servicesDir)
 
-    try {
-      await stat(servicesDirFullPath)
-      await cleanServicesConfig(logger, servicesDirFullPath, entrypoint)
-      await manageServicesEnvFiles(servicesDirFullPath, currentDir, entrypoint)
-    } catch (err) {
-      // do nothing. There are no services to manage, somehow.
-    }
+  if (servicesDir && entrypoint && entrypointPort) {
+    const servicesDirFullPath = isAbsolute(servicesDir)
+      ? servicesDir
+      : join(currentDir, servicesDir)
+
+    const entrypointPath = join(servicesDirFullPath, entrypoint)
+    await updateEntrypointConfig(logger, entrypointPath)
+    await updateEntrypointEnv(entrypointPort, logger, entrypointPath)
   }
 
   return {}
 }
-/**
- *
- * @param {string} servicesDir the services dir
- * @param {string | null} entrypoint the entrypoint. If specified the function will filter it out
- * @returns {Promise}
- */
-async function getAllServices (servicesDir, entrypoint = null) {
-  const services = (await readdir(servicesDir))
-  if (entrypoint) {
-    return services.filter(dir => dir !== entrypoint)
-  }
-  return services
-}
-async function cleanServicesConfig (logger, servicesDir, entrypoint) {
-  const services = await getAllServices(servicesDir, entrypoint)
-  for (const svc of services) {
-    const serviceDir = join(servicesDir, svc)
-    const configFile = await findConfigFile(serviceDir)
-    if (!configFile) {
-      logger.warn(`Cannot find config file in ${serviceDir}`)
-    } else {
-      console.log(`Found config file ${configFile}`)
-      const configFilePath = join(serviceDir, configFile)
-      const config = JSON.parse(await readFile(configFilePath, 'utf8'))
-      delete config.server
-      await writeFile(configFilePath, JSON.stringify(config, null, 2))
-    }
+
+async function updateEntrypointConfig (logger, currentDir) {
+  const accessibleConfigFilename = await findConfigFile(currentDir)
+  if (accessibleConfigFilename === undefined) {
+    logger.error('Cannot find an entrypoint configuration file.')
+    return
   }
-}
 
-async function manageServicesEnvFiles (servicesDir, runtimeDir, entrypoint) {
-  let mainEnvFile = ''
-  const services = await getAllServices(servicesDir)
-  for (const svc of services) {
-    const envFile = await readFile(join(servicesDir, svc, '.env'), 'utf8')
-    if (svc === entrypoint) {
-      // copy the whole file
-      mainEnvFile += `\n${envFile}`
-    } else {
-      // read .env file
-      const lines = envFile.split('\n')
-      lines.forEach((line) => {
-        // copy to main env file only if line _doesn't_ match
-        // i.e any other config or comments
-        if (!line.match(/(PLT_LOGGER_LEVEL|PORT|PLT_SERVER_HOSTNAME)=/)) {
-          mainEnvFile += `\n${line}`
-        }
-      })
-    }
-    try {
-      await unlink(join(servicesDir, svc, '.env.sample'))
-    } catch (err) {
-      // do nothing
+  const configPath = join(currentDir, accessibleConfigFilename)
+  const config = JSON.parse(await readFile(configPath, 'utf8'))
+
+  config.server = {
+    hostname: '{PLT_SERVER_HOSTNAME}',
+    port: '{PORT}',
+    logger: {
+      level: '{PLT_SERVER_LOGGER_LEVEL}'
     }
   }
-  await writeFile(join(runtimeDir, '.env'), mainEnvFile)
+
+  await writeFile(configPath, JSON.stringify(config, null, 2))
 }
 
-async function findConfigFile (dir) {
-  const allFiles = await readdir(dir)
-  return allFiles.find((file) => {
-    return file.match(/platformatic\.(.*)\.json/)
-  })
+async function updateEntrypointEnv (port, logger, currentDir) {
+  const env = `\
+PLT_SERVER_HOSTNAME=127.0.0.1
+PORT=${port}
+PLT_SERVER_LOGGER_LEVEL=info
+  `
+
+  await appendFile(join(currentDir, '.env'), env)
+  await writeFile(join(currentDir, '.env.sample'), env)
 }
 
 export default createRuntime

package/src/service/create-service-cli.mjs

@@ -55,8 +55,13 @@ const createPlatformaticService = async (_args, opts = {}) => {
   const pkgManager = getPkgManager()
 
   const projectDir = opts.dir || await askDir(logger, '.')
+  const isRuntimeContext = opts.isRuntimeContext || false
 
-  const toAsk = [getUseTypescript(args.typescript), getPort(args.port)]
+  const toAsk = [getUseTypescript(args.typescript)]
+
+  if (!isRuntimeContext) {
+    toAsk.push(getPort(args.port))
+  }
 
   if (!opts.skipPackageJson) {
     toAsk.unshift(getRunPackageManagerInstall(pkgManager))
@@ -68,10 +73,10 @@ const createPlatformaticService = async (_args, opts = {}) => {
   await mkdir(projectDir, { recursive: true })
 
   const params = {
+    isRuntimeContext,
     hostname: args.hostname,
     port,
-    typescript: useTypescript,
-    isRuntime: opts.isRuntime
+    typescript: useTypescript
   }
 
   const env = await createService(params, logger, projectDir, version)

package/src/service/create-service.mjs

@@ -7,7 +7,7 @@ import { generatePlugins } from '../create-plugins.mjs'
 
 const TS_OUT_DIR = 'dist'
 
-function generateConfig (version, typescript) {
+function generateConfig (isRuntimeContext, version, typescript) {
   const plugins = {
     paths: [
       { path: './plugins', encapsulate: false },
@@ -17,17 +17,20 @@ function generateConfig (version, typescript) {
 
   const config = {
     $schema: `https://platformatic.dev/schemas/v${version}/service`,
-    server: {
+    service: {
+      openapi: true
+    },
+    plugins
+  }
+
+  if (!isRuntimeContext) {
+    config.server = {
       hostname: '{PLT_SERVER_HOSTNAME}',
       port: '{PORT}',
       logger: {
         level: '{PLT_SERVER_LOGGER_LEVEL}'
       }
-    },
-    service: {
-      openapi: true
-    },
-    plugins
+    }
   }
 
   if (typescript === true) {
@@ -37,12 +40,16 @@ function generateConfig (version, typescript) {
   return config
 }
 
-function generateEnv (hostname, port, typescript) {
-  let env = `\
+function generateEnv (isRuntimeContext, hostname, port, typescript) {
+  let env = ''
+
+  if (!isRuntimeContext) {
+    env += `\
 PLT_SERVER_HOSTNAME=${hostname}
 PORT=${port}
 PLT_SERVER_LOGGER_LEVEL=info
 `
+  }
 
   if (typescript === true) {
     env += `\
@@ -56,7 +63,9 @@ PLT_TYPESCRIPT=true
   return env
 }
 
-async function createService ({ hostname, port, typescript = false }, logger, currentDir = process.cwd(), version) {
+async function createService (params, logger, currentDir = process.cwd(), version) {
+  const { isRuntimeContext, hostname, port, typescript = false } = params
+
   if (!version) {
     const pkg = await readFile(desm.join(import.meta.url, '..', '..', 'package.json'))
     version = JSON.parse(pkg).version
@@ -64,11 +73,11 @@ async function createService ({ hostname, port, typescript = false }, logger, cu
   const accessibleConfigFilename = await findServiceConfigFile(currentDir)
 
   if (accessibleConfigFilename === undefined) {
-    const config = generateConfig(version, typescript)
+    const config = generateConfig(isRuntimeContext, version, typescript)
     await writeFile(join(currentDir, 'platformatic.service.json'), JSON.stringify(config, null, 2))
     logger.info('Configuration file platformatic.service.json successfully created.')
 
-    const env = generateEnv(hostname, port, typescript)
+    const env = generateEnv(isRuntimeContext, hostname, port, typescript)
     const envFileExists = await isFileAccessible('.env', currentDir)
     await appendFile(join(currentDir, '.env'), env)
     await writeFile(join(currentDir, '.env.sample'), env)

package/src/utils.mjs

@@ -61,6 +61,7 @@ export async function isDirectoryWriteable (directory) {
   }
 }
 
+export const findConfigFile = async (directory) => (ConfigManager.findConfigFile(directory))
 export const findDBConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'db'))
 export const findServiceConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'service'))
 export const findComposerConfigFile = async (directory) => (ConfigManager.findConfigFile(directory, 'composer'))