@platformatic/composer 2.72.0 → 3.0.0-alpha.1

package/lib/schema.js

@@ -1,13 +1,16 @@
 #! /usr/bin/env node
-'use strict'
 
-const { metrics, server, plugins, watch, clients, openApiBase, openApiDefs, graphqlBase } =
-  require('@platformatic/service').schemas
-const { schemaComponents } = require('@platformatic/utils')
-const telemetry = require('@platformatic/telemetry').schema
-const pkg = require('../package.json')
+import { schemaComponents as serviceSchemaComponents } from '@platformatic/service'
+import { fastifyServer as server, schemaComponents as utilsSchemaComponents, watch, wrappedRuntime } from '@platformatic/utils'
+import { readFileSync } from 'node:fs'
+import { resolve } from 'node:path'
 
-const openApiService = {
+const { $defs, clients, graphqlBase, openApiBase, plugins } = serviceSchemaComponents
+
+export const packageJson = JSON.parse(readFileSync(resolve(import.meta.dirname, '../package.json'), 'utf8'))
+export const version = packageJson.version
+
+export const openApiService = {
   type: 'object',
   properties: {
     url: { type: 'string' },
@@ -19,7 +22,7 @@ const openApiService = {
   additionalProperties: false
 }
 
-const entityResolver = {
+export const entityResolver = {
   type: 'object',
   properties: {
     name: { type: 'string' },
@@ -34,7 +37,7 @@ const entityResolver = {
   additionalProperties: false
 }
 
-const entities = {
+export const entities = {
   type: 'object',
   patternProperties: {
     '^.*$': {
@@ -77,7 +80,7 @@ const entities = {
   }
 }
 
-const graphqlService = {
+export const graphqlService = {
   anyOf: [
     { type: 'boolean' },
     {
@@ -94,7 +97,7 @@ const graphqlService = {
   ]
 }
 
-const graphqlComposerOptions = {
+export const graphqlComposerOptions = {
   type: 'object',
   properties: {
     ...graphqlBase.properties,
@@ -109,7 +112,7 @@ const graphqlComposerOptions = {
   additionalProperties: false
 }
 
-const composer = {
+export const composer = {
   type: 'object',
   properties: {
     services: {
@@ -179,7 +182,7 @@ const composer = {
   additionalProperties: false
 }
 
-const types = {
+export const types = {
   type: 'object',
   properties: {
     autogenerate: {
@@ -195,10 +198,20 @@ const types = {
   additionalProperties: false
 }
 
-const platformaticComposerSchema = {
-  $id: `https://schemas.platformatic.dev/@platformatic/composer/${pkg.version}.json`,
+export const schemaComponents = {
+  openApiService,
+  entityResolver,
+  entities,
+  graphqlService,
+  graphqlComposerOptions,
+  composer,
+  types
+}
+
+export const schema = {
+  $id: `https://schemas.platformatic.dev/@platformatic/composer/${packageJson.version}.json`,
   $schema: 'http://json-schema.org/draft-07/schema#',
-  title: 'Platformatic Composer',
+  title: 'Platformatic Composer Config',
   type: 'object',
   properties: {
     basePath: {
@@ -206,12 +219,11 @@ const platformaticComposerSchema = {
     },
     server,
     composer,
-    metrics,
     types,
     plugins,
     clients,
-    runtime: schemaComponents.wrappedRuntime,
-    telemetry,
+    runtime: wrappedRuntime,
+    telemetry: utilsSchemaComponents.telemetry,
     watch: {
       anyOf: [
         watch,
@@ -231,12 +243,10 @@ const platformaticComposerSchema = {
     }
   },
   additionalProperties: false,
-  $defs: openApiDefs
+  $defs
 }
 
-module.exports.schema = platformaticComposerSchema
-
 /* c8 ignore next 3 */
-if (require.main === module) {
-  console.log(JSON.stringify(platformaticComposerSchema, null, 2))
+if (process.argv[1] === import.meta.filename) {
+  console.log(JSON.stringify(schema, null, 2))
 }

package/lib/stackable.js

@@ -1,38 +1,29 @@
-'use strict'
-
-const { ServiceStackable } = require('@platformatic/service')
+import { ServiceStackable } from '@platformatic/service'
+import { kMetadata, replaceEnv } from '@platformatic/utils'
+import { ensureServices, platformaticComposer } from './application.js'
+import { notHostConstraints } from './not-host-constraints.js'
+import { packageJson } from './schema.js'
 
 const kITC = Symbol.for('plt.runtime.itc')
 
-async function ensureServices (composerId, config) {
-  if (config.composer?.services?.length) {
-    return
-  }
-
-  composerId ??= globalThis.platformatic?.serviceId
-  config.composer ??= {}
-  config.composer.services ??= []
+export class ComposerStackable extends ServiceStackable {
+  #meta
+  #dependencies
 
-  // When no services are defined, all services are exposed in the composer
-  const services = await globalThis[kITC]?.send('listServices')
+  constructor (root, config, context) {
+    super(root, config, context)
+    this.type = 'composer'
+    this.version = packageJson.version
 
-  if (services) {
-    config.composer.services = services
-      .filter(id => id !== composerId) // Remove ourself
-      .map(id => ({ id, proxy: { prefix: `/${id}` } }))
+    this.applicationFactory = this.context.applicationFactory ?? platformaticComposer
+    this.fastifyOptions ??= {}
+    this.fastifyOptions.constraints = { notHost: notHostConstraints }
   }
-}
-
-class ComposerStackable extends ServiceStackable {
-  #meta
-  #dependencies
 
   async getBootstrapDependencies () {
-    await ensureServices(this.serviceId, this.configManager.current)
-
-    // We do not call init() on purpose, as we don't want to load the app just yet.
+    await ensureServices(this.serviceId, this.config)
 
-    const composedServices = this.configManager.current.composer?.services
+    const composedServices = this.config.composer?.services
     const dependencies = []
 
     if (Array.isArray(composedServices)) {
@@ -64,20 +55,20 @@ class ComposerStackable extends ServiceStackable {
   }
 
   async isHealthy () {
-    // Still booting, assume healthy
-    if (!this.#dependencies) {
-      return true
-    }
-
-    const composedServices = this.#dependencies.map(dep => dep.id)
-    const workers = await globalThis[kITC].send('getWorkers')
-
-    for (const worker of Object.values(workers)) {
-      if (composedServices.includes(worker.service) && !worker.status.startsWith('start')) {
-        return false
+    // If no dependencies (still booting), assume healthy
+    if (this.#dependencies) {
+      const composedServices = this.#dependencies.map(dep => dep.id)
+      const workers = await globalThis[kITC].send('getWorkers')
+
+      for (const worker of Object.values(workers)) {
+        if (composedServices.includes(worker.service) && !worker.status.startsWith('start')) {
+          globalThis[kITC].notify('event', { event: 'unhealthy' })
+          return false
+        }
       }
     }
 
+    globalThis[kITC].notify('event', { event: 'healthy' })
     return true
   }
 
@@ -85,7 +76,7 @@ class ComposerStackable extends ServiceStackable {
     let url = `http://${id}.plt.local`
 
     if (urlString) {
-      const remoteUrl = await this.configManager.replaceEnv(urlString)
+      const remoteUrl = await replaceEnv(urlString, this.config[kMetadata].env)
 
       if (remoteUrl) {
         url = remoteUrl
@@ -95,4 +86,3 @@ class ComposerStackable extends ServiceStackable {
     return { id, url, local: url.endsWith('.plt.local') }
   }
 }
-module.exports = { ComposerStackable, ensureServices }

package/lib/upgrade.js

@@ -1,15 +1,13 @@
-'use strict'
-
-const { join } = require('path')
-
-module.exports = async function upgrade (config, version) {
-  const { semgrator } = await import('semgrator')
+import { abstractLogger } from '@platformatic/utils'
+import { resolve } from 'node:path'
+import { semgrator } from 'semgrator'
 
+export async function upgrade (logger, config, version) {
   const iterator = semgrator({
     version,
-    path: join(__dirname, 'versions'),
+    path: resolve(import.meta.dirname, 'versions'),
     input: config,
-    logger: this.logger.child({ name: '@platformatic/composer' }),
+    logger: logger?.child({ name: '@platformatic/composer' }) ?? abstractLogger
   })
 
   let result

package/lib/utils.js

@@ -1,10 +1,6 @@
-'use strict'
-
-function prefixWithSlash (url) {
+export function prefixWithSlash (url) {
   if (typeof url === 'string') {
-    return url.startsWith('/')
-      ? url
-      : `/${url}`
+    return url.startsWith('/') ? url : `/${url}`
   }
   return ''
 }
@@ -14,14 +10,7 @@ function prefixWithSlash (url) {
  * a service can have openapi and/or gql either from a remote service or from file
  * note service.origin is always been set if missing at index.js/platformaticComposer
  * @returns {boolean}
-*/
-function isFetchable (service) {
-  return Boolean(
-    (service?.openapi && service.openapi.url) || service?.graphql
-  )
-}
-
-module.exports = {
-  prefixWithSlash,
-  isFetchable,
+ */
+export function isFetchable (service) {
+  return Boolean((service?.openapi && service.openapi.url) || service?.graphql)
 }

package/lib/versions/2.0.0.js

@@ -1,11 +1,9 @@
-'use strict'
+import { version } from '../schema.js'
 
-const pkg = require('../../package.json')
-
-module.exports = {
+export default {
   version: '2.0.0',
-  up: function (config) {
-    config.$schema = `https://schemas.platformatic.dev/@platformatic/composer/${pkg.version}.json`
+  up (config) {
+    config.$schema = `https://schemas.platformatic.dev/@platformatic/composer/${version}.json`
     return config
   }
 }

package/package.json

@@ -1,11 +1,10 @@
 {
   "name": "@platformatic/composer",
-  "version": "2.72.0",
+  "version": "3.0.0-alpha.1",
   "description": "",
   "main": "index.js",
-  "bin": {
-    "plt-composer": "./composer.mjs"
-  },
+  "types": "index.d.ts",
+  "type": "module",
   "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
   "repository": {
     "type": "git",
@@ -25,7 +24,6 @@
     "neostandard": "^0.12.0",
     "openapi-schema-validator": "^12.1.3",
     "pino-test": "^1.0.1",
-    "prom-client": "^15.1.2",
     "self-cert": "^2.0.0",
     "single-user-cache": "^1.0.1",
     "split2": "^4.2.0",
@@ -33,24 +31,22 @@
     "typescript": "^5.5.4",
     "why-is-node-running": "2",
     "ws": "^8.16.0",
-    "@platformatic/config": "2.72.0",
-    "@platformatic/client": "2.72.0",
-    "@platformatic/db": "2.72.0"
+    "@platformatic/db": "3.0.0-alpha.1",
+    "@platformatic/client": "3.0.0-alpha.1"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
-    "@fastify/http-proxy": "^11.3.0",
+    "@fastify/http-proxy": "^11.2.0",
     "@fastify/reply-from": "^12.0.0",
     "@fastify/static": "^8.0.0",
     "@fastify/swagger": "^9.0.0",
     "@fastify/view": "^10.0.1",
     "@platformatic/fastify-openapi-glue": "^5.1.0",
     "@platformatic/graphql-composer": "^0.10.0",
-    "@scalar/fastify-api-reference": "1.32.4",
+    "@scalar/fastify-api-reference": "1.31.14",
     "ajv": "^8.12.0",
     "commist": "^3.2.0",
     "console-table-printer": "^2.12.0",
-    "desm": "^1.3.1",
     "es-main": "^1.3.0",
     "execa": "^9.0.0",
     "fast-deep-equal": "^3.1.3",
@@ -69,15 +65,15 @@
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^7.0.0",
-    "@platformatic/generators": "2.72.0",
-    "@platformatic/config": "2.72.0",
-    "@platformatic/scalar-theme": "2.72.0",
-    "@platformatic/service": "2.72.0",
-    "@platformatic/telemetry": "2.72.0",
-    "@platformatic/utils": "^2.72.0"
+    "@platformatic/basic": "3.0.0-alpha.1",
+    "@platformatic/generators": "3.0.0-alpha.1",
+    "@platformatic/scalar-theme": "3.0.0-alpha.1",
+    "@platformatic/service": "3.0.0-alpha.1",
+    "@platformatic/telemetry": "3.0.0-alpha.1",
+    "@platformatic/utils": "^3.0.0-alpha.1"
   },
   "scripts": {
-    "test": "pnpm run lint && borp -T --timeout=1200000 -c 1 && tsd",
+    "test": "pnpm run lint && borp -T --timeout 1200000 -c 1",
     "gen-schema": "node lib/schema.js > schema.json",
     "gen-types": "json2ts > config.d.ts < schema.json",
     "build": "pnpm run gen-schema && pnpm run gen-types",

package/schema.json

@@ -1,7 +1,7 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/composer/2.72.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/composer/3.0.0-alpha.1.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Platformatic Composer",
+  "title": "Platformatic Composer Config",
   "type": "object",
   "properties": {
     "basePath": {
@@ -1115,77 +1115,6 @@
       "default": {},
       "additionalProperties": false
     },
-    "metrics": {
-      "anyOf": [
-        {
-          "type": "boolean"
-        },
-        {
-          "type": "object",
-          "properties": {
-            "port": {
-              "anyOf": [
-                {
-                  "type": "integer"
-                },
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "hostname": {
-              "type": "string"
-            },
-            "endpoint": {
-              "type": "string"
-            },
-            "server": {
-              "type": "string",
-              "enum": [
-                "own",
-                "parent",
-                "hide"
-              ]
-            },
-            "defaultMetrics": {
-              "type": "object",
-              "properties": {
-                "enabled": {
-                  "type": "boolean"
-                }
-              },
-              "required": [
-                "enabled"
-              ],
-              "additionalProperties": false
-            },
-            "auth": {
-              "type": "object",
-              "properties": {
-                "username": {
-                  "type": "string"
-                },
-                "password": {
-                  "type": "string"
-                }
-              },
-              "additionalProperties": false,
-              "required": [
-                "username",
-                "password"
-              ]
-            },
-            "labels": {
-              "type": "object",
-              "additionalProperties": {
-                "type": "string"
-              }
-            }
-          },
-          "additionalProperties": false
-        }
-      ]
-    },
     "types": {
       "type": "object",
       "properties": {

package/.c8rc

@@ -1,6 +0,0 @@
-{
-  "exclude": [
-    "fixtures/*",
-    "test/*"
-  ]
-}

package/composer.mjs

@@ -1,54 +0,0 @@
-#! /usr/bin/env node
-
-import { readFile } from 'fs/promises'
-
-import commist from 'commist'
-import parseArgs from 'minimist'
-import isMain from 'es-main'
-import helpMe from 'help-me'
-import { join } from 'desm'
-import { start } from '@platformatic/service'
-import { printAndExitLoadConfigError } from '@platformatic/config'
-
-import { fetchOpenApiSchemas } from './lib/openapi-fetch-schemas.mjs'
-import { platformaticComposer } from './index.js'
-import { createComposer } from './lib/create.mjs'
-const help = helpMe({
-  dir: join(import.meta.url, 'help'),
-  // the default
-  ext: '.txt',
-})
-
-const program = commist({ maxDistance: 2 })
-
-program.register('start', (argv) => {
-  start(platformaticComposer, argv).catch(printAndExitLoadConfigError)
-})
-program.register('openapi schemas fetch', (argv) => {
-  return fetchOpenApiSchemas(argv).catch(printAndExitLoadConfigError)
-})
-program.register('create', createComposer)
-
-export async function runComposer (argv) {
-  const args = parseArgs(argv, {
-    alias: {
-      v: 'version',
-    },
-  })
-
-  if (args.version) {
-    console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'), 'utf-8')).version)
-    process.exit(0)
-  }
-
-  const output = await program.parseAsync(argv)
-
-  return {
-    output,
-    help,
-  }
-}
-
-if (isMain(import.meta)) {
-  await runComposer(process.argv.splice(2))
-}

package/help/create.txt

@@ -1,11 +0,0 @@
-Creates a new Platformatic Composer application.
-
-Options are
-
-* `dir <string>` - the directory where to create the project (Default: `process.cwd() + 'platformatic-composer'`)
-* `port <string>` - the port where the application will listen (Default: `3042`)
-* `hostname <string>` - the hostname where the application will listen (Default: `0.0.0.0`)
-* `git <boolean>` - Init the git repository (Default: `true`)
-* `typescript <boolean>` - Use Typescript (Default: `false`)
-* `install <boolean>` - Run or not `npm install` after creating the files (Default: `true`)
-* `plugin <boolean>` - Creates a sample plugin and tests (Default: `true`)

package/help/help.txt

@@ -1,7 +0,0 @@
-Available commands:
-
-* `create` - creates a new Platformatic Composer application.
-* `help` - show this help message.
-* `help <command>` - shows more information about a command.
-* `start` - start the server.
-* `openapi schemas fetch` - fetch OpenAPI schemas from services.

package/help/openapi schemas fetch.txt

@@ -1,9 +0,0 @@
-Fetch OpenAPI schemas from remote services to use in your Platformatic project.
-
-``` bash
-  $ platformatic composer openapi schemas fetch
-```
-
-It will fetch all the schemas from the remote services and store them by path
-set in the `platformatic.json` file. If the path is not set, it will
-skip fetching the schema.

package/help/start.txt

@@ -1,54 +0,0 @@
-Start the Platformatic Composer server with the following command:
-
-``` bash
- $ platformatic composer start
- ```
-
-You will need a configuration file. Here is an example to get you started,
-save the following as `platformatic.json`:
-
-``` json
-  {
-    "server": {
-      "hostname": "127.0.0.1",
-      "port": 0,
-      "logger": {
-        "level": "info"
-      }
-    },
-    "composer": {
-      "services": [
-        {
-          "id": "service1",
-          "origin": "http://127.0.0.1:3051",
-          "openapi": {
-            "url": "/documentation/json"
-          }
-        },
-        {
-          "id": "service2",
-          "origin": "http://127.0.0.1:3052",
-          "openapi": {
-            "file": "./schemas/service2.openapi.json"
-          }
-        }
-      ],
-      "refreshTimeout": 1000
-    }
-  }
-```
-
-By sending the SIGUSR2 signal, the server can be reloaded.
-
-Options:
-
-* `-c, --config FILE` - Specify a configuration file to use.
-
-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`
-
-You can find more details about the configuration format here:
-* [Platformatic Composer Configuration](https://docs.platformatic.dev/docs/composer/configuration)

package/index.test-d.ts

@@ -1,23 +0,0 @@
-import { buildServer, PlatformaticApp, PlatformaticComposerConfig } from '.'
-import ConfigManager from '@platformatic/config'
-import { expectType } from 'tsd'
-
-declare module 'fastify' {
-  interface FastifyInstance {
-    platformatic: PlatformaticApp<PlatformaticComposerConfig>
-  }
-}
-
-async function main (): Promise<void> {
-  // TODO this configuration is incomplete, type it fully
-  const server = await buildServer({
-    server: {
-      port: 3042,
-      host: '127.0.0.1'
-    }
-  })
-
-  expectType<ConfigManager<PlatformaticComposerConfig>>(server.platformatic.configManager)
-}
-
-main().catch(console.error)