@platformatic/composer 3.0.0-alpha.1 → 3.0.0-alpha.2

package/config.d.ts

@@ -377,17 +377,7 @@ export interface PlatformaticComposerConfig {
   plugins?: {
     [k: string]: unknown;
   };
-  clients?: {
-    serviceId?: string;
-    name?: string;
-    type?: "openapi" | "graphql";
-    path?: string;
-    schema?: string;
-    url?: string;
-    fullResponse?: boolean;
-    fullRequest?: boolean;
-    validateResponse?: boolean;
-  }[];
+  application?: {};
   runtime?: {
     preload?: string | string[];
     basePath?: string;

package/index.js

@@ -1,6 +1,6 @@
 import { resolve, validationOptions } from '@platformatic/basic'
+import { kMetadata, loadConfiguration as utilsLoadConfiguration } from '@platformatic/foundation'
 import { transform } from '@platformatic/service'
-import { kMetadata, loadConfiguration as utilsLoadConfiguration } from '@platformatic/utils'
 import { schema } from './lib/schema.js'
 import { ComposerStackable } from './lib/stackable.js'
 import { upgrade } from './lib/upgrade.js'

package/lib/application.js

@@ -1,5 +1,5 @@
+import { isKeyEnabled } from '@platformatic/foundation'
 import { platformaticService } from '@platformatic/service'
-import { isKeyEnabled } from '@platformatic/utils'
 import deepEqual from 'fast-deep-equal'
 import { fetchOpenApiSchema } from './commands/openapi-fetch-schemas.js'
 import { composerHook } from './composer-hook.js'

package/lib/commands/openapi-fetch-schemas.js

@@ -1,4 +1,4 @@
-import { loadConfiguration } from '@platformatic/utils'
+import { loadConfiguration } from '@platformatic/foundation'
 import { writeFile } from 'node:fs/promises'
 import { request } from 'undici'
 import { FailedToFetchOpenAPISchemaError } from '../errors.js'

package/lib/generator.js

@@ -1,16 +1,16 @@
-import { BaseGenerator } from '@platformatic/generators'
+import { Generator as ServiceGenerator } from '@platformatic/service'
 
-export class Generator extends BaseGenerator {
+export class Generator extends ServiceGenerator {
   constructor (opts) {
     super({
       ...opts,
       module: '@platformatic/composer'
     })
-    this.runtime = null
   }
 
   getDefaultConfig () {
     const defaultBaseConfig = super.getDefaultConfig()
+
     return {
       ...defaultBaseConfig,
       plugin: false,
@@ -19,94 +19,33 @@ export class Generator extends BaseGenerator {
     }
   }
 
-  async _getConfigFileContents () {
-    const template = {
-      $schema: `https://schemas.platformatic.dev/@platformatic/composer/${this.platformaticVersion}.json`,
-      composer: {
-        services: [
-          {
-            id: 'example',
-            origin: `{${this.getEnvVarName('PLT_EXAMPLE_ORIGIN')}}`,
-            openapi: {
-              url: '/documentation/json'
-            }
-          }
-        ],
-        refreshTimeout: 1000
-      },
-      watch: true
-    }
-    if (this.runtime !== null) {
-      template.composer.services = this.runtime.services
-        .filter(serviceMeta => serviceMeta.service.module !== '@platformatic/composer')
-        .map(serviceMeta => {
-          return {
-            id: serviceMeta.name,
-            openapi: {
-              url: '/documentation/json',
-              prefix: `/${serviceMeta.name}`
-            }
-          }
-        })
-    }
-
-    if (this.config.plugin) {
-      template.plugins = {
-        paths: [
-          {
-            path: './plugins',
-            encapsulate: false
-          },
-          './routes'
-        ],
-        typescript: `{${this.getEnvVarName('PLT_TYPESCRIPT')}}`
-      }
+  async _beforePrepare () {
+    if (this.config.isUpdating) {
+      return
     }
 
-    if (!this.config.isRuntimeContext) {
-      template.server = {
-        hostname: '{PLT_SERVER_HOSTNAME}',
-        port: '{PORT}',
-        logger: {
-          level: '{PLT_SERVER_LOGGER_LEVEL}'
-        }
-      }
-    }
+    await super._beforePrepare()
 
-    return template
-  }
+    this.addEnvVars(
+      {
+        PLT_EXAMPLE_ORIGIN: 'http://127.0.0.1:3043'
+      },
+      { overwrite: false, default: true }
+    )
 
-  async _beforePrepare () {
-    if (!this.config.isUpdating) {
-      if (!this.config.isRuntimeContext) {
-        this.addEnvVars(
-          {
-            PLT_SERVER_HOSTNAME: this.config.hostname,
-            PLT_SERVER_LOGGER_LEVEL: 'info',
-            PORT: 3042
-          },
-          { overwrite: false, default: true }
-        )
-      }
-
-      this.addEnvVars(
-        {
-          PLT_TYPESCRIPT: this.config.typescript,
-          PLT_EXAMPLE_ORIGIN: 'http://127.0.0.1:3043'
-        },
-        { overwrite: false, default: true }
-      )
-
-      this.config.dependencies = {
-        '@platformatic/composer': `^${this.platformaticVersion}`
-      }
+    this.config.dependencies = {
+      '@platformatic/composer': `^${this.platformaticVersion}`
     }
   }
 
   async _afterPrepare () {
-    if (!this.config.isUpdating) {
-      const PLT_ENVIRONMENT_TEMPLATE = `
-import { FastifyInstance } from 'fastify'
+    if (this.config.isUpdating) {
+      return
+    }
+
+    await super._afterPrepare()
+    const PLT_ENVIRONMENT_TEMPLATE = `
+import { type FastifyInstance } from 'fastify'
 import { PlatformaticApplication, PlatformaticComposerConfig } from '@platformatic/composer'
 
 declare module 'fastify' {
@@ -116,7 +55,7 @@ declare module 'fastify' {
 }
 `
 
-      const README = `
+    const README = `
 # Platformatic Composer API
 
 This is a generated [Platformatic Composer](https://docs.platformatic.dev/docs/composer/overview) application.
@@ -147,12 +86,42 @@ npm start
 - 📔 View the REST API's Swagger documentation at http://localhost:3042/documentation/      
 `
 
-      this.addFile({ path: '', file: 'plt-env.d.ts', contents: PLT_ENVIRONMENT_TEMPLATE })
-      this.addFile({ path: '', file: 'README.md', contents: README })
-    }
+    this.addFile({ path: '', file: 'plt-env.d.ts', contents: PLT_ENVIRONMENT_TEMPLATE })
+    this.addFile({ path: '', file: 'README.md', contents: README })
   }
 
-  setRuntime (runtime) {
-    this.runtime = runtime
+  async _getConfigFileContents () {
+    const config = await super._getConfigFileContents()
+    delete config.service
+    config.$schema = `https://schemas.platformatic.dev/@platformatic/composer/${this.platformaticVersion}.json`
+
+    config.composer = {
+      services: [
+        {
+          id: 'example',
+          origin: `{${this.getEnvVarName('PLT_EXAMPLE_ORIGIN')}}`,
+          openapi: {
+            url: '/documentation/json'
+          }
+        }
+      ],
+      refreshTimeout: 1000
+    }
+
+    if (this.runtime !== null) {
+      config.composer.services = this.runtime.services
+        .filter(serviceMeta => serviceMeta.service.module !== '@platformatic/composer')
+        .map(serviceMeta => {
+          return {
+            id: serviceMeta.name,
+            openapi: {
+              url: '/documentation/json',
+              prefix: `/${serviceMeta.name}`
+            }
+          }
+        })
+    }
+
+    return config
   }
 }

package/lib/metrics.js

@@ -0,0 +1,12 @@
+export function initMetrics (prometheus) {
+  if (!prometheus?.registry || !prometheus?.client) return null
+  const { client, registry } = prometheus
+
+  return {
+    activeWsConnections: new client.Gauge({
+      name: 'active_ws_composer_connections',
+      help: 'Active Websocket composer connections in "@platformatic/composer"',
+      registers: [registry]
+    })
+  }
+}

package/lib/proxy.js

@@ -1,9 +1,10 @@
 import httpProxy from '@fastify/http-proxy'
-import { ensureLoggableError, loadModule } from '@platformatic/utils'
+import { ensureLoggableError, loadModule } from '@platformatic/foundation'
 import fp from 'fastify-plugin'
 import { createRequire } from 'node:module'
 import { workerData } from 'node:worker_threads'
 import { getGlobalDispatcher } from 'undici'
+import { initMetrics } from './metrics.js'
 
 const kITC = Symbol.for('plt.runtime.itc')
 const kProxyRoute = Symbol('plt.composer.proxy.route')
@@ -51,6 +52,8 @@ async function resolveServiceProxyParameters (service) {
   }
 }
 
+let metrics
+
 async function proxyPlugin (app, opts) {
   const meta = { proxies: {} }
   const hostnameLessProxies = []
@@ -80,16 +83,16 @@ async function proxyPlugin (app, opts) {
     const basePath = `/${prefix ?? ''}`.replaceAll(/\/+/g, '/').replace(/\/$/, '')
     const dispatcher = getGlobalDispatcher()
 
+    let preRewrite = null
+
     if (needsRootTrailingSlash) {
-      app.addHook('preHandler', function rootTrailingSlashPreHandler (req, reply, done) {
-        if (req.url !== basePath) {
-          done()
-          return
+      preRewrite = function preRewrite (url) {
+        if (url === basePath) {
+          url += '/'
         }
 
-        const { url, options } = reply.fromParameters(req.url + '/', req.params, prefix)
-        reply.from(url.replace(/\/+$/, '/'), options)
-      })
+        return url
+      }
     }
 
     /*
@@ -144,17 +147,28 @@ async function proxyPlugin (app, opts) {
       )
       : null
 
+    if (!metrics) {
+      metrics = initMetrics(globalThis.platformatic?.prometheus)
+    }
+
     const proxyOptions = {
       prefix,
       rewritePrefix,
       upstream: service.proxy?.upstream ?? origin,
+      preRewrite,
 
       websocket: true,
       wsUpstream: ws?.upstream ?? url ?? origin,
       wsReconnect: ws?.reconnect,
       wsHooks: {
-        onConnect: ws?.hooks?.onConnect,
-        onDisconnect: ws?.hooks?.onDisconnect,
+        onConnect: (...args) => {
+          metrics?.activeWsConnections?.inc()
+          ws?.hooks?.onConnect(...args)
+        },
+        onDisconnect: (...args) => {
+          metrics?.activeWsConnections?.dec()
+          ws?.hooks?.onDisconnect(...args)
+        },
         onReconnect: ws?.hooks?.onReconnect,
         onPong: ws?.hooks?.onPong,
         onIncomingMessage: ws?.hooks?.onIncomingMessage,

package/lib/schema.js

@@ -1,11 +1,17 @@
 #! /usr/bin/env node
 
+import { schemaComponents as basicSchemaComponents } from '@platformatic/basic'
+import {
+  fastifyServer as server,
+  schemaComponents as utilsSchemaComponents,
+  watch,
+  wrappedRuntime
+} from '@platformatic/foundation'
 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 { $defs, clients, graphqlBase, openApiBase, plugins } = serviceSchemaComponents
+const { $defs, graphqlBase, openApiBase, plugins } = serviceSchemaComponents
 
 export const packageJson = JSON.parse(readFileSync(resolve(import.meta.dirname, '../package.json'), 'utf8'))
 export const version = packageJson.version
@@ -221,7 +227,7 @@ export const schema = {
     composer,
     types,
     plugins,
-    clients,
+    application: basicSchemaComponents.application,
     runtime: wrappedRuntime,
     telemetry: utilsSchemaComponents.telemetry,
     watch: {

package/lib/stackable.js

@@ -1,5 +1,5 @@
+import { kMetadata, replaceEnv } from '@platformatic/foundation'
 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'

package/lib/upgrade.js

@@ -1,4 +1,4 @@
-import { abstractLogger } from '@platformatic/utils'
+import { abstractLogger } from '@platformatic/foundation'
 import { resolve } from 'node:path'
 import { semgrator } from 'semgrator'
 

package/lib/versions/3.0.0.js

@@ -0,0 +1,14 @@
+export default {
+  version: '2.99.0',
+  up (config) {
+    if (typeof config.plugins?.typescript !== 'undefined') {
+      delete config.plugins.typescript
+    }
+
+    if (typeof config.clients !== 'undefined') {
+      delete config.clients
+    }
+
+    return config
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/composer",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.2",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -24,6 +24,7 @@
     "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",
@@ -31,23 +32,21 @@
     "typescript": "^5.5.4",
     "why-is-node-running": "2",
     "ws": "^8.16.0",
-    "@platformatic/db": "3.0.0-alpha.1",
-    "@platformatic/client": "3.0.0-alpha.1"
+    "@platformatic/client": "3.0.0-alpha.2",
+    "@platformatic/db": "3.0.0-alpha.2"
   },
   "dependencies": {
     "@fastify/error": "^4.0.0",
-    "@fastify/http-proxy": "^11.2.0",
+    "@fastify/http-proxy": "^11.3.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.31.14",
+    "@scalar/fastify-api-reference": "1.33.0",
     "ajv": "^8.12.0",
-    "commist": "^3.2.0",
     "console-table-printer": "^2.12.0",
-    "es-main": "^1.3.0",
     "execa": "^9.0.0",
     "fast-deep-equal": "^3.1.3",
     "fastify": "^5.0.0",
@@ -60,17 +59,19 @@
     "my-ua-parser": "^2.0.2",
     "nunjucks": "^3.2.4",
     "ora": "^6.3.1",
-    "pino": "^9.0.0",
+    "pino": "^9.9.0",
     "pino-pretty": "^13.0.0",
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^7.0.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"
+    "@platformatic/basic": "3.0.0-alpha.2",
+    "@platformatic/service": "3.0.0-alpha.2",
+    "@platformatic/scalar-theme": "3.0.0-alpha.2",
+    "@platformatic/telemetry": "3.0.0-alpha.2",
+    "@platformatic/foundation": "^3.0.0-alpha.2"
+  },
+  "engines": {
+    "node": ">=22.18.0"
   },
   "scripts": {
     "test": "pnpm run lint && borp -T --timeout 1200000 -c 1",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/composer/3.0.0-alpha.1.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/composer/3.0.0-alpha.2.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Composer Config",
   "type": "object",
@@ -1221,45 +1221,6 @@
               }
             ]
           }
-        },
-        "typescript": {
-          "anyOf": [
-            {
-              "type": "object",
-              "properties": {
-                "enabled": {
-                  "anyOf": [
-                    {
-                      "type": "boolean"
-                    },
-                    {
-                      "type": "string"
-                    }
-                  ]
-                },
-                "tsConfig": {
-                  "type": "string",
-                  "resolvePath": true
-                },
-                "outDir": {
-                  "type": "string",
-                  "resolvePath": true
-                },
-                "flags": {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                }
-              }
-            },
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "string"
-            }
-          ]
         }
       },
       "additionalProperties": false,
@@ -1276,47 +1237,12 @@
         }
       ]
     },
-    "clients": {
-      "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "serviceId": {
-            "type": "string"
-          },
-          "name": {
-            "type": "string"
-          },
-          "type": {
-            "type": "string",
-            "enum": [
-              "openapi",
-              "graphql"
-            ]
-          },
-          "path": {
-            "type": "string",
-            "resolvePath": true
-          },
-          "schema": {
-            "type": "string",
-            "resolvePath": true
-          },
-          "url": {
-            "type": "string"
-          },
-          "fullResponse": {
-            "type": "boolean"
-          },
-          "fullRequest": {
-            "type": "boolean"
-          },
-          "validateResponse": {
-            "type": "boolean"
-          }
-        },
-        "additionalProperties": false
-      }
+    "application": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false,
+      "required": [],
+      "default": {}
     },
     "runtime": {
       "type": "object",