platformatic 2.0.0-alpha.3 → 2.0.0-alpha.5

package/cli.js

@@ -13,6 +13,7 @@ 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,
@@ -66,6 +67,7 @@ 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('client', client)
 program.register('compile', async (args) => await compile(args) ? null : process.exit(1))
 program.register('help', help.toStdout)
@@ -89,7 +91,7 @@ const args = minimist(process.argv.slice(2), {
 })
 
 if (args.version && !args._.includes('inject')) {
-  const version = JSON.parse(await readFile(join(import.meta.url, 'package.json'))).version
+  const version = JSON.parse(await readFile(join(import.meta.url, 'package.json'), 'utf-8')).version
   console.log('v' + version)
   process.exit(0)
 }

package/help/download.txt

@@ -0,0 +1,55 @@
+Download Platformatic Runtime external services
+
+``` bash
+ $ platformatic download
+```
+
+Options:
+
+* `-c, --config FILE` - Path to the runtime configuration file.
+
+Platformatic download command downloads 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.
+
+Example of the runtime platformatic.json configuration file:
+
+```json
+{
+  "$schema": "https://schemas.platformatic.dev/@platformatic/runtime/2.0.0.json",
+  "entrypoint": "service-1",
+  "services": [
+    {
+      "id": "service-1",
+      "path": "./services/service-1",
+      "config": "platformatic.json"
+    },
+    {
+      "id": "service-2",
+      "config": "platformatic.json",
+      "url": "https://github.com/test-owner/test-service.git"
+    },
+    {
+      "id": "service-3",
+      "config": "platformatic.json",
+      "path": "./custom-external/service-3",
+      "url": "https://github.com/test-owner/test-service.git"
+    }
+  ],
+}
+```
+
+If not specified, the configuration will be loaded from any of the following, in the current directory.
+
+* `platformatic.json`, or
+* `platformatic.yml`, or 
+* `platformatic.tml`, or 
+* `platformatic.json`, or
+* `platformatic.yml`, or 
+* `platformatic.tml`
+
+You can find more details about the configuration format here:
+* [Platformatic DB Configuration](https://docs.platformatic.dev/docs/db/configuration)
+* [Platformatic Service Configuration](https://docs.platformatic.dev/docs/service/configuration)

package/lib/download.js

@@ -0,0 +1,121 @@
+import { join, relative } from 'node:path'
+import { access, writeFile, mkdir, readdir } from 'node:fs/promises'
+import { Store, 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'
+
+export async function download (argv) {
+  const args = parseArgs(argv, {
+    alias: {
+      config: 'c',
+    },
+    boolean: ['test'],
+    default: { test: false },
+  })
+
+  const logger = pino(pretty({
+    translateTime: 'SYS:HH:MM:ss',
+    ignore: 'hostname,pid',
+  }))
+  try {
+    await downloadServices(args.config, logger, args.test)
+  } catch (err) {
+    console.log(err)
+    process.exit(1)
+  }
+}
+
+async function downloadServices (config, logger, isTest = false) {
+  const store = new Store({
+    cwd: process.cwd(),
+    logger,
+  })
+  store.add(platformaticRuntime)
+
+  const { configManager } = await store.loadConfig({
+    config,
+    overrides: {
+      fixPaths: false,
+      onMissingEnv (key) {
+        return '{' + key + '}'
+      },
+    },
+  })
+
+  await configManager.parseAndValidate(true)
+  config = configManager.current
+
+  // 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)
+
+  if (!config.services || config.services.length === 0) {
+    logger.info('No external services to download')
+    return
+  }
+
+  const services = config.services || []
+  for (const service of services) {
+    if (service.url) {
+      let path = service.path
+      if (!path || (path.startsWith('{') && path.endsWith('}'))) {
+        await mkdir(externalDir, { recursive: true })
+        path = join(externalDir, service.id)
+        service.path = relative(projectDir, path)
+      } else {
+        path = join(projectDir, path)
+      }
+
+      const isNotEmpty = await isDirectoryNotEmpty(path)
+      if (isNotEmpty) {
+        logger.info(`Skipping ${service.id} as it is not empty`)
+        continue
+      }
+
+      const relativePath = relative(projectDir, path)
+
+      logger.info(`Cloning ${service.url} into ${relativePath}`)
+      if (!isTest) {
+        await execa('git', ['clone', service.url, path])
+      }
+
+      // TODO: replace it with a proper runtime build step
+      logger.info(`Downloading dependencies for service "${service.id}"`)
+      if (!isTest) {
+        await execa('npm', ['i'], { cwd: path })
+      }
+
+      if (!service.path) {
+        service.path = relativePath
+      }
+    }
+  }
+
+  const stringify = getStringifier(configManager.fullPath)
+  const newConfig = stringify(config)
+
+  await writeFile(configManager.fullPath, newConfig, 'utf8')
+
+  logger.info('✅ All external services have been downloaded')
+}
+
+async function isDirectoryNotEmpty (directoryPath) {
+  try {
+    await access(directoryPath)
+    const files = await readdir(directoryPath)
+    return files.length > 0
+  } catch (err) {
+    return false
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "platformatic",
-  "version": "2.0.0-alpha.3",
+  "version": "2.0.0-alpha.5",
   "description": "Platformatic CLI",
   "main": "cli.js",
   "type": "module",
@@ -37,9 +37,9 @@
     "neostandard": "^0.11.1",
     "split2": "^4.2.0",
     "typescript": "^5.5.3",
-    "@platformatic/composer": "2.0.0-alpha.3",
-    "@platformatic/db": "2.0.0-alpha.3",
-    "@platformatic/service": "2.0.0-alpha.3"
+    "@platformatic/composer": "2.0.0-alpha.5",
+    "@platformatic/service": "2.0.0-alpha.5",
+    "@platformatic/db": "2.0.0-alpha.5"
   },
   "dependencies": {
     "@fastify/error": "^3.4.1",
@@ -56,14 +56,14 @@
     "pino": "^8.19.0",
     "pino-pretty": "^11.0.0",
     "undici": "^6.9.0",
-    "@platformatic/client-cli": "2.0.0-alpha.3",
-    "@platformatic/config": "2.0.0-alpha.3",
-    "@platformatic/control": "2.0.0-alpha.3",
-    "@platformatic/db": "2.0.0-alpha.3",
-    "@platformatic/frontend-template": "2.0.0-alpha.3",
-    "@platformatic/runtime": "2.0.0-alpha.3",
-    "@platformatic/utils": "2.0.0-alpha.3",
-    "create-platformatic": "2.0.0-alpha.3"
+    "@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"
   },
   "scripts": {
     "test": "pnpm run lint && borp --timeout=180000 --concurrency 1",