platformatic 2.0.0-alpha.5 → 2.0.0-alpha.7

package/cli.js

@@ -1,32 +1,33 @@
 #! /usr/bin/env node
 
-import { createRequire } from 'node:module'
-import path from 'node:path'
-import { pathToFileURL } from 'node:url'
-import { readFile } from 'node:fs/promises'
-import commist from 'commist'
-import minimist from 'minimist'
-import { run as runRuntime, compile } from '@platformatic/runtime/runtime.mjs'
-import { startCommand } from '@platformatic/runtime'
 import { command as client } from '@platformatic/client-cli'
-import { join } from 'desm'
-import { isColorSupported } from 'colorette'
-import helpMe from 'help-me'
-import { upgrade } from './lib/upgrade.js'
-import { download } from './lib/download.js'
-import { logo } from './lib/ascii.js'
 import {
-  runControl,
   getRuntimesCommand,
   injectRuntimeCommand,
-  streamRuntimeLogsCommand,
+  runControl,
+  streamRuntimeLogsCommand
 } from '@platformatic/control/control.js'
+import { startCommand } from '@platformatic/runtime'
+import { compile, run as runRuntime } from '@platformatic/runtime/runtime.mjs'
+import { isColorSupported } from 'colorette'
+import commist from 'commist'
+import { join } from 'desm'
+import helpMe from 'help-me'
+import minimist from 'minimist'
+import { readFile } from 'node:fs/promises'
+import { createRequire } from 'node:module'
+import path from 'node:path'
+import { pathToFileURL } from 'node:url'
+import { logo } from './lib/ascii.js'
+import { build } from './lib/build.js'
+import { resolve } from './lib/resolve.js'
+import { upgrade } from './lib/upgrade.js'
 
 const program = commist({ maxDistance: 2 })
 const help = helpMe({
   dir: join(import.meta.url, 'help'),
   // the default
-  ext: '.txt',
+  ext: '.txt'
 })
 
 async function load (moduleName) {
@@ -48,36 +49,37 @@ const ensureCommand = async ({ output, help }) => {
   process.exit(1)
 }
 
-program.register('db', async (args) => {
+program.register('db', async args => {
   const { runDB } = await load('@platformatic/db/db.mjs')
   return ensureCommand(await runDB(args))
 })
-program.register('runtime', async (args) => ensureCommand(await runRuntime(args)))
-program.register('service', async (args) => {
+program.register('runtime', async args => ensureCommand(await runRuntime(args)))
+program.register('service', async args => {
   const { runService } = await load('@platformatic/service/service.mjs')
   return ensureCommand(await runService(args))
 })
-program.register('composer', async (args) => {
+program.register('composer', async args => {
   const { runComposer } = await load('@platformatic/composer/composer.mjs')
   return ensureCommand(await runComposer(args))
 })
-program.register('start', async (args) => ensureCommand(await startCommand(args)))
-program.register('ctl', async (args) => ensureCommand(await runControl(args)))
-program.register('ps', async (args) => getRuntimesCommand(args))
-program.register('inject', async (args) => injectRuntimeCommand(args))
-program.register('logs', async (args) => streamRuntimeLogsCommand(args))
+program.register('start', async args => ensureCommand(await startCommand(args)))
+program.register('ctl', async args => ensureCommand(await runControl(args)))
+program.register('ps', async args => getRuntimesCommand(args))
+program.register('inject', async args => injectRuntimeCommand(args))
+program.register('logs', async args => streamRuntimeLogsCommand(args))
 program.register('upgrade', upgrade)
-program.register('download', download)
+program.register('resolve', resolve)
 program.register('client', client)
-program.register('compile', async (args) => await compile(args) ? null : process.exit(1))
+program.register('build', build)
+program.register('compile', async args => ((await compile(args)) ? null : process.exit(1)))
 program.register('help', help.toStdout)
-program.register('help db', async (args) => {
+program.register('help db', async args => {
   const { runDB } = await load('@platformatic/db/db.mjs')
   return runDB(['help', ...args])
 })
 program.register('help client', () => client([]))
-program.register('help runtime', async (args) => runRuntime(['help', ...args]))
-program.register('help service', async (args) => {
+program.register('help runtime', async args => runRuntime(['help', ...args]))
+program.register('help service', async args => {
   const { runService } = await load('@platformatic/service/service.mjs')
   return runService(['help', ...args])
 })
@@ -86,8 +88,8 @@ const args = minimist(process.argv.slice(2), {
   boolean: ['help', 'version'],
   alias: {
     help: 'h',
-    version: 'v',
-  },
+    version: 'v'
+  }
 })
 
 if (args.version && !args._.includes('inject')) {
@@ -101,7 +103,7 @@ if (args.help) {
 } else if (process.argv.length > 2) {
   const output = await program.parseAsync(process.argv.slice(2))
   await ensureCommand({ output, help })
-/* c8 ignore start */
+  /* c8 ignore start */
 } else {
   if (isColorSupported && process.stdout.isTTY) {
     console.log(logo)

package/eslint.config.js

@@ -1,3 +1,3 @@
 import neostandard from 'neostandard'
 
-export default neostandard({})
+export default neostandard({ ignores: ['**/.astro', '**/.next', '**/.vite', '**/dist'] })

package/help/help.txt

@@ -1,15 +1,18 @@
 Welcome to Platformatic. Available commands are:
 
-* `help` - display this message.
-* `help <command>` - show more information about a command.
 * `db` - start Platformatic DB; type `platformatic db help` to know more.
-* `service` - start Platformatic Service; type `platformatic service help` to know more.
-* `upgrade` - upgrade the Platformatic configuration to the latest version.
-* `gh` - create a new gh action for Platformatic deployments.
 * `runtime` - start Platformatic Runtime; type `platformatic runtime help` to know more.
+* `service` - start Platformatic Service; type `platformatic service help` to know more.
+* `composer` - start Platformatic Composer; type `platformatic composer help` to know more.
 * `start` - start a Platformatic application.
-* `client` - generate a Platformatic client.
+* `ctl` - Platformatic Control commands; `platformatic ctl help` to know more.
 * `ps` - list all Platformatic runtime applications.
-* `logs` - stream logs for a Platformatic runtime application.
 * `inject` - inject a request into a Platformatic runtime application.
-* `ctl` - Platformatic Control commands; `platformatic ctl help` to know more.
+* `logs` - stream logs for a Platformatic runtime application.
+* `upgrade` - upgrade the Platformatic configuration to the latest version.
+* `resolve` - resolve Platformatic Runtime external services
+* `client` - generate a Platformatic client.
+* `build` - builds all services.
+* `compile` - compile all typescript plugins.
+* `help` - display this message.
+* `help <command>` - show more information about a command.

package/help/{download.txt → resolve.txt}

@@ -1,18 +1,20 @@
-Download Platformatic Runtime external services
+Resolve Platformatic Runtime external services
 
 ``` bash
- $ platformatic download
+ $ platformatic resolve
 ```
 
 Options:
 
 * `-c, --config FILE` - Path to the runtime configuration file.
+* `-u, --username string` - Username for the service repository.
+* `-p, --password string` - Password for the service repository.
 
-Platformatic download command downloads runtime services that have the `url` in their configuration.
+Platformatic resolve command resolves runtime services that have the `url` in their configuration.
 By default services are cloned with `git` to the `external` directory inside the runtime directory.
 To change the directory where a service is cloned, you can set the `path` property in the service configuration.
 
-After cloning the service, the download command will set the relative path to the service in the runtime configuration file.
+After cloning the service, the resolve command will set the relative path to the service in the runtime configuration file.
 
 Example of the runtime platformatic.json configuration file:
 

package/lib/build.js

@@ -0,0 +1,80 @@
+import platformaticBasic from '@platformatic/basic'
+import { Store, loadConfig as pltConfigLoadConfig } from '@platformatic/config'
+import { buildRuntime, platformaticRuntime } from '@platformatic/runtime'
+import { execa, parseCommandString } from 'execa'
+import { once } from 'node:events'
+import split from 'split2'
+
+async function loadConfig (minimistConfig, args, overrides, replaceEnv = true) {
+  const store = new Store()
+  store.add(platformaticRuntime)
+  store.add(platformaticBasic)
+
+  return pltConfigLoadConfig(minimistConfig, args, store, overrides, replaceEnv)
+}
+
+async function buildService (logger, id, cwd, command) {
+  const [executable, ...args] = parseCommandString(command)
+  const subprocess = execa(executable, args, {
+    all: true,
+    lines: false,
+    stripFinalNewline: false,
+    reject: false,
+    preferLocal: true,
+    cwd
+  })
+
+  const exitPromise = once(subprocess, 'exit')
+
+  const output = []
+  for await (const line of subprocess.all.pipe(split())) {
+    logger.debug(`  ${line}`)
+    output.push(line)
+  }
+  logger.debug('')
+  output.push('')
+
+  const [exitCode] = await exitPromise
+
+  if (exitCode !== 0) {
+    logger.error(`❌ Building service ${id} (${command}) failed with exit code ${exitCode}: `)
+
+    for (const line of output) {
+      logger.error(`  ${line}`)
+    }
+
+    process.exit(1)
+  }
+}
+
+export async function build (args) {
+  const config = await loadConfig({}, args)
+  config.configManager.args = config.args
+
+  const runtimeConfig = config.configManager
+  const runtime = await buildRuntime(runtimeConfig)
+  const logger = runtime.logger
+
+  // Gather informations for all services before starting
+  const toBuild = new Map()
+  const { services } = await runtime.getServices()
+
+  for (const { id } of services) {
+    const { path } = runtimeConfig.current.serviceMap.get(id)
+    const meta = await runtime.getServiceMeta(id)
+
+    if (meta?.deploy?.buildCommand) {
+      toBuild.set(id, [path, meta.deploy.buildCommand])
+    }
+  }
+
+  // Build all services
+  for (const [id, [cwd, command]] of toBuild) {
+    logger.info(`Building service "${id}" (${command}) ...`)
+
+    await buildService(logger, id, cwd, command)
+  }
+
+  logger.info('✅ All external services have been built.')
+  await runtime.close(false, true)
+}

package/lib/{download.js → resolve.js}

@@ -1,21 +1,23 @@
-import { join, relative } from 'node:path'
-import { access, writeFile, mkdir, readdir } from 'node:fs/promises'
-import { Store, getStringifier } from '@platformatic/config'
+import { join, relative, resolve as resolvePath } from 'node:path'
+import { access, writeFile, readFile, mkdir, readdir } from 'node:fs/promises'
+import { Store, getParser, getStringifier } from '@platformatic/config'
 import { platformaticRuntime } from '@platformatic/runtime'
 import parseArgs from 'minimist'
 import pino from 'pino'
 import pretty from 'pino-pretty'
 import { execa } from 'execa'
-import fjs from 'fast-json-stringify'
 
-const DOWNLOAD_SERVICES_DIRNAME = 'external'
+const RESOLVED_SERVICES_DIRNAME = 'external'
 
-export async function download (argv) {
+export async function resolve (argv) {
   const args = parseArgs(argv, {
     alias: {
       config: 'c',
+      username: 'u',
+      password: 'p',
     },
     boolean: ['test'],
+    string: ['config', 'username', 'password'],
     default: { test: false },
   })
 
@@ -24,14 +26,18 @@ export async function download (argv) {
     ignore: 'hostname,pid',
   }))
   try {
-    await downloadServices(args.config, logger, args.test)
+    await resolveServices(args.config, logger, {
+      test: args.test,
+      username: args.username,
+      password: args.password,
+    })
   } catch (err) {
     console.log(err)
     process.exit(1)
   }
 }
 
-async function downloadServices (config, logger, isTest = false) {
+async function resolveServices (configPath, logger, options = {}) {
   const store = new Store({
     cwd: process.cwd(),
     logger,
@@ -39,42 +45,47 @@ async function downloadServices (config, logger, isTest = false) {
   store.add(platformaticRuntime)
 
   const { configManager } = await store.loadConfig({
-    config,
+    config: configPath,
     overrides: {
-      fixPaths: false,
       onMissingEnv (key) {
         return '{' + key + '}'
       },
     },
   })
 
-  await configManager.parseAndValidate(true)
-  config = configManager.current
+  configPath = configManager.fullPath
 
-  // If the schema is present, we use it to format the config
-  if (configManager.schema) {
-    const stringify = fjs(configManager.schema)
-    config = JSON.parse(stringify(config))
-  }
-
-  const projectDir = configManager.dirname
-  const externalDir = join(projectDir, DOWNLOAD_SERVICES_DIRNAME)
+  const parseConfig = getParser(configPath)
+  const configFile = await readFile(configPath, 'utf8')
+  const config = await parseConfig(configFile)
 
   if (!config.services || config.services.length === 0) {
-    logger.info('No external services to download')
+    logger.info('No external services to resolve')
     return
   }
 
+  const projectDir = configManager.dirname
+  const externalDir = join(projectDir, RESOLVED_SERVICES_DIRNAME)
+
   const services = config.services || []
   for (const service of services) {
     if (service.url) {
       let path = service.path
-      if (!path || (path.startsWith('{') && path.endsWith('}'))) {
+      if (path && path.startsWith('{') && path.endsWith('}')) {
+        path = await configManager.replaceEnv(path)
+
+        // Failed to resolve the path
+        if (path.startsWith('{') && path.endsWith('}')) {
+          path = null
+        }
+      }
+
+      if (!path) {
         await mkdir(externalDir, { recursive: true })
         path = join(externalDir, service.id)
         service.path = relative(projectDir, path)
       } else {
-        path = join(projectDir, path)
+        path = resolvePath(projectDir, path)
       }
 
       const isNotEmpty = await isDirectoryNotEmpty(path)
@@ -86,13 +97,22 @@ async function downloadServices (config, logger, isTest = false) {
       const relativePath = relative(projectDir, path)
 
       logger.info(`Cloning ${service.url} into ${relativePath}`)
-      if (!isTest) {
-        await execa('git', ['clone', service.url, path])
+      if (!options.test) {
+        let url = service.url
+        if (options.username && options.password) {
+          const urlObj = new URL(service.url)
+          if (!urlObj.username && !urlObj.password) {
+            urlObj.username = options.username
+            urlObj.password = options.password
+          }
+          url = urlObj.href
+        }
+        await execa('git', ['clone', url, path])
       }
 
       // TODO: replace it with a proper runtime build step
-      logger.info(`Downloading dependencies for service "${service.id}"`)
-      if (!isTest) {
+      logger.info(`Resolving dependencies for service "${service.id}"`)
+      if (!options.test) {
         await execa('npm', ['i'], { cwd: path })
       }
 
@@ -102,12 +122,12 @@ async function downloadServices (config, logger, isTest = false) {
     }
   }
 
-  const stringify = getStringifier(configManager.fullPath)
-  const newConfig = stringify(config)
+  const stringifyConfig = getStringifier(configPath)
+  const newConfig = stringifyConfig(config)
 
   await writeFile(configManager.fullPath, newConfig, 'utf8')
 
-  logger.info('✅ All external services have been downloaded')
+  logger.info('✅ All external services have been resolved')
 }
 
 async function isDirectoryNotEmpty (directoryPath) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "platformatic",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.7",
   "description": "Platformatic CLI",
   "main": "cli.js",
   "type": "module",
@@ -34,12 +34,18 @@
     "fastify": "^4.26.2",
     "license-checker": "^25.0.1",
     "mkdirp": "^2.1.6",
+    "minimatch": "^10.0.1",
     "neostandard": "^0.11.1",
     "split2": "^4.2.0",
     "typescript": "^5.5.3",
-    "@platformatic/composer": "2.0.0-alpha.5",
-    "@platformatic/service": "2.0.0-alpha.5",
-    "@platformatic/db": "2.0.0-alpha.5"
+    "@platformatic/astro": "2.0.0-alpha.7",
+    "@platformatic/composer": "2.0.0-alpha.7",
+    "@platformatic/db": "2.0.0-alpha.7",
+    "@platformatic/next": "2.0.0-alpha.7",
+    "@platformatic/remix": "2.0.0-alpha.7",
+    "@platformatic/service": "2.0.0-alpha.7",
+    "@platformatic/node": "2.0.0-alpha.7",
+    "@platformatic/vite": "2.0.0-alpha.7"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
@@ -47,7 +53,7 @@
     "commist": "^3.2.0",
     "desm": "^1.3.1",
     "dotenv": "^16.4.5",
-    "execa": "^8.0.1",
+    "execa": "^9.3.1",
     "fast-json-stringify": "^5.14.1",
     "graphql": "^16.8.1",
     "help-me": "^5.0.0",
@@ -55,18 +61,20 @@
     "minimist": "^1.2.8",
     "pino": "^8.19.0",
     "pino-pretty": "^11.0.0",
+    "split2": "^4.2.0",
     "undici": "^6.9.0",
-    "@platformatic/client-cli": "2.0.0-alpha.5",
-    "@platformatic/control": "2.0.0-alpha.5",
-    "@platformatic/db": "2.0.0-alpha.5",
-    "@platformatic/frontend-template": "2.0.0-alpha.5",
-    "@platformatic/runtime": "2.0.0-alpha.5",
-    "create-platformatic": "2.0.0-alpha.5",
-    "@platformatic/utils": "2.0.0-alpha.5",
-    "@platformatic/config": "2.0.0-alpha.5"
+    "@platformatic/control": "2.0.0-alpha.7",
+    "@platformatic/client-cli": "2.0.0-alpha.7",
+    "@platformatic/db": "2.0.0-alpha.7",
+    "@platformatic/config": "2.0.0-alpha.7",
+    "@platformatic/frontend-template": "2.0.0-alpha.7",
+    "@platformatic/basic": "2.0.0-alpha.7",
+    "@platformatic/runtime": "2.0.0-alpha.7",
+    "@platformatic/utils": "2.0.0-alpha.7",
+    "create-platformatic": "2.0.0-alpha.7"
   },
   "scripts": {
-    "test": "pnpm run lint && borp --timeout=180000 --concurrency 1",
+    "test": "pnpm run lint && borp --timeout=600000 --concurrency 1",
     "lint": "eslint",
     "license": "license-checker --production --onlyAllow 'Apache-2.0;MIT;ISC;BSD-2-Clause;BSD-3-Clause;CC-BY-4.0'"
   }