@platformatic/service 1.51.8 → 2.0.0-alpha.2

package/lib/schema.js

@@ -5,391 +5,7 @@
 const pkg = require('../package.json')
 const openApiDefs = require('./openapi-schema-defs')
 const telemetry = require('@platformatic/telemetry').schema
-
-const cors = {
-  type: 'object',
-  $comment: 'See https://github.com/fastify/fastify-cors',
-  properties: {
-    origin: {
-      anyOf: [
-        { type: 'boolean' },
-        { type: 'string' },
-        {
-          type: 'array',
-          items: {
-            anyOf: [{
-              type: 'string'
-            }, {
-              type: 'object',
-              properties: {
-                regexp: {
-                  type: 'string'
-                }
-              },
-              required: ['regexp']
-            }]
-          }
-        },
-        {
-          type: 'object',
-          properties: {
-            regexp: {
-              type: 'string'
-            }
-          },
-          required: ['regexp']
-        }
-      ]
-    },
-    methods: {
-      type: 'array',
-      items: {
-        type: 'string'
-      }
-    },
-    allowedHeaders: {
-      type: 'string',
-      description: 'Comma separated string of allowed headers.'
-    },
-    exposedHeaders: {
-      anyOf: [
-        {
-          type: 'array',
-          items: {
-            type: 'string'
-          }
-        },
-        {
-          type: 'string',
-          description: 'Comma separated string of exposed headers.'
-        }
-      ]
-    },
-    credentials: {
-      type: 'boolean'
-    },
-    maxAge: {
-      type: 'integer'
-    },
-    preflightContinue: {
-      type: 'boolean',
-      default: false
-    },
-    optionsSuccessStatus: {
-      type: 'integer',
-      default: 204
-    },
-    preflight: {
-      type: 'boolean',
-      default: true
-    },
-    strictPreflight: {
-      type: 'boolean',
-      default: true
-    },
-    hideOptionsRoute: {
-      type: 'boolean',
-      default: true
-    }
-  },
-  additionalProperties: false
-}
-
-const server = {
-  type: 'object',
-  properties: {
-    // TODO add support for level
-    hostname: {
-      type: 'string'
-    },
-    port: {
-      anyOf: [
-        { type: 'integer' },
-        { type: 'string' }
-      ]
-    },
-    pluginTimeout: {
-      type: 'integer'
-    },
-    healthCheck: {
-      anyOf: [
-        { type: 'boolean' },
-        {
-          type: 'object',
-          properties: {
-            enabled: { type: 'boolean' },
-            interval: { type: 'integer' }
-          },
-          additionalProperties: true
-        }
-      ]
-    },
-    ignoreTrailingSlash: {
-      type: 'boolean'
-    },
-    ignoreDuplicateSlashes: {
-      type: 'boolean'
-    },
-    connectionTimeout: {
-      type: 'integer'
-    },
-    keepAliveTimeout: {
-      type: 'integer',
-      default: 5000
-    },
-    maxRequestsPerSocket: {
-      type: 'integer'
-    },
-    forceCloseConnections: {
-      anyOf: [
-        { type: 'boolean' },
-        { type: 'string', pattern: '^idle$' }
-      ]
-    },
-    requestTimeout: {
-      type: 'integer'
-    },
-    bodyLimit: {
-      type: 'integer'
-    },
-    maxParamLength: {
-      type: 'integer'
-    },
-    disableRequestLogging: {
-      type: 'boolean'
-    },
-    exposeHeadRoutes: {
-      type: 'boolean'
-    },
-    logger: {
-      anyOf: [
-        { type: 'boolean' },
-        {
-          type: 'object',
-          properties: {
-            level: {
-              type: 'string'
-            },
-            transport: {
-              anyOf: [{
-                type: 'object',
-                properties: {
-                  target: {
-                    type: 'string',
-                    resolveModule: true
-                  },
-                  options: {
-                    type: 'object'
-                  }
-                },
-                additionalProperties: false
-              }, {
-                type: 'object',
-                properties: {
-                  targets: {
-                    type: 'array',
-                    items: {
-                      type: 'object',
-                      properties: {
-                        target: {
-                          type: 'string',
-                          resolveModule: true
-                        },
-                        options: {
-                          type: 'object'
-                        },
-                        level: {
-                          type: 'string'
-                        },
-                        additionalProperties: false
-                      }
-                    }
-                  },
-                  options: {
-                    type: 'object'
-                  }
-                },
-                additionalProperties: false
-              }]
-            },
-            pipeline: {
-              type: 'object',
-              properties: {
-                target: {
-                  type: 'string',
-                  resolveModule: true
-                },
-                options: {
-                  type: 'object'
-                }
-              },
-              additionalProperties: false
-            }
-          },
-          additionalProperties: true
-        }
-      ]
-    },
-    serializerOpts: {
-      type: 'object',
-      properties: {
-        schema: {
-          type: 'object'
-        },
-        ajv: {
-          type: 'object'
-        },
-        rounding: {
-          type: 'string',
-          enum: ['floor', 'ceil', 'round', 'trunc'],
-          default: 'trunc'
-        },
-        debugMode: {
-          type: 'boolean'
-        },
-        mode: {
-          type: 'string',
-          enum: ['debug', 'standalone']
-        },
-        largeArraySize: {
-          anyOf: [
-            { type: 'integer' },
-            { type: 'string' }
-          ],
-          default: 20000
-        },
-        largeArrayMechanism: {
-          type: 'string',
-          enum: ['default', 'json-stringify'],
-          default: 'default'
-        }
-      }
-    },
-    caseSensitive: {
-      type: 'boolean'
-    },
-    requestIdHeader: {
-      anyOf: [
-        { type: 'string' },
-        { type: 'boolean', const: false }
-      ]
-    },
-    requestIdLogLabel: {
-      type: 'string'
-    },
-    jsonShorthand: {
-      type: 'boolean'
-    },
-    trustProxy: {
-      anyOf: [
-        { type: 'boolean' },
-        { type: 'string' },
-        {
-          type: 'array',
-          items: {
-            type: 'string'
-          }
-        },
-        { type: 'integer' }
-      ]
-    },
-    http2: {
-      type: 'boolean'
-    },
-    https: {
-      type: 'object',
-      properties: {
-        allowHTTP1: {
-          type: 'boolean'
-        },
-        key: {
-          anyOf: [
-            {
-              type: 'string'
-            },
-            {
-              type: 'object',
-              properties: {
-                path: {
-                  type: 'string',
-                  resolvePath: true
-                }
-              },
-              additionalProperties: false
-            },
-            {
-              type: 'array',
-              items: {
-                anyOf: [
-                  {
-                    type: 'string'
-                  },
-                  {
-                    type: 'object',
-                    properties: {
-                      path: {
-                        type: 'string',
-                        resolvePath: true
-                      }
-                    },
-                    additionalProperties: false
-                  }
-                ]
-              }
-            }
-          ]
-        },
-        cert: {
-          anyOf: [
-            {
-              type: 'string'
-            },
-            {
-              type: 'object',
-              properties: {
-                path: {
-                  type: 'string',
-                  resolvePath: true
-                }
-              },
-              additionalProperties: false
-            },
-            {
-              type: 'array',
-              items: {
-                anyOf: [
-                  {
-                    type: 'string'
-                  },
-                  {
-                    type: 'object',
-                    properties: {
-                      path: {
-                        type: 'string',
-                        resolvePath: true
-                      }
-                    },
-                    additionalProperties: false
-                  }
-                ]
-              }
-            }
-          ]
-        },
-        requestCert: {
-          type: 'boolean'
-        },
-        rejectUnauthorized: {
-          type: 'boolean'
-        }
-      },
-      additionalProperties: false,
-      required: ['key', 'cert']
-    },
-    cors
-  },
-  additionalProperties: false
-}
+const { server, cors } = require('@platformatic/utils').schemas
 
 const watch = {
   type: 'object',
@@ -726,47 +342,6 @@ const clients = {
   }
 }
 
-const version = {
-  type: 'object',
-  properties: {
-    version: { type: 'string' },
-    openapi: {
-      type: 'object',
-      properties: {
-        prefix: {
-          type: 'string'
-        },
-        path: {
-          type: 'string',
-          resolvePath: true
-        }
-      },
-      additionalProperties: false
-    },
-    plugins
-  },
-  required: ['version'],
-  additionalProperties: false
-}
-
-const versions = {
-  type: 'object',
-  properties: {
-    dir: {
-      type: 'string',
-      description: 'The path to the directory containing the versions mappers',
-      resolvePath: true,
-      default: 'versions'
-    },
-    configs: {
-      type: 'array',
-      items: version
-    }
-  },
-  required: ['dir', 'configs'],
-  additionalProperties: false
-}
-
 const platformaticServiceSchema = {
   $id: `https://platformatic.dev/schemas/v${pkg.version}/service`,
   version: pkg.version,
@@ -788,13 +363,68 @@ const platformaticServiceSchema = {
       type: 'string'
     },
     service,
-    clients,
-    versions
+    clients
   },
   additionalProperties: false,
   $defs: openApiDefs
 }
 
+/*
+ * Legacy definitions for backwards compatibility.
+ * They are non/enumerable to avoid being included in the schema.
+ */
+Object.defineProperty(platformaticServiceSchema, 'schema', {
+  enumerable: false,
+  value: platformaticServiceSchema
+})
+
+Object.defineProperty(platformaticServiceSchema, 'server', {
+  enumerable: false,
+  value: server
+})
+
+Object.defineProperty(platformaticServiceSchema, 'cors', {
+  enumerable: false,
+  value: cors
+})
+
+Object.defineProperty(platformaticServiceSchema, 'metrics', {
+  enumerable: false,
+  value: metrics
+})
+
+Object.defineProperty(platformaticServiceSchema, 'plugins', {
+  enumerable: false,
+  value: plugins
+})
+
+Object.defineProperty(platformaticServiceSchema, 'watch', {
+  enumerable: false,
+  value: watch
+})
+
+Object.defineProperty(platformaticServiceSchema, 'openApiDefs', {
+  enumerable: false,
+  value: openApiDefs
+})
+
+Object.defineProperty(platformaticServiceSchema, 'openApiBase', {
+  enumerable: false,
+  value: openApiBase
+})
+
+Object.defineProperty(platformaticServiceSchema, 'graphqlBase', {
+  enumerable: false,
+  value: graphqlBase
+})
+
+Object.defineProperty(platformaticServiceSchema, 'clients', {
+  enumerable: false,
+  value: clients
+})
+
+/* end */
+
 module.exports.schema = platformaticServiceSchema
 module.exports.metrics = metrics
 module.exports.cors = cors

package/lib/start.js

@@ -2,7 +2,6 @@
 
 const { readFile } = require('fs/promises')
 const close = require('close-with-grace')
-const { Bus } = require('@platformatic/bus')
 const { loadConfig, ConfigManager, printConfigValidationErrors, printAndExitLoadConfigError } = require('@platformatic/config')
 const { addLoggerToTheConfig, isDocker } = require('./utils.js')
 const { restartable } = require('@fastify/restartable')
@@ -61,12 +60,10 @@ async function buildServer (options, app) {
     }
     fastifyOptions.genReqId = function (req) { return randomUUID() }
     const root = fastify(fastifyOptions)
-    root.decorate('platformatic', { configManager, config, bus: new Bus(options.id) })
+    root.decorate('platformatic', { configManager, config })
     await root.register(app)
     if (!root.hasRoute({ url: '/', method: 'GET' })) {
-      await root.register(require('./root-endpoint'), {
-        versions: config.versions
-      })
+      await root.register(require('./root-endpoint'))
     }
 
     root.decorate('url', {

package/lib/utils.js

@@ -70,126 +70,6 @@ function getJSPluginPath (workingDir, tsPluginPath, compileDir) {
   return join(compileDir, jsPluginRelativePath)
 }
 
-function convertOpenApiToFastifyPath (openApiPath) {
-  return openApiPath
-    .replace(/{wildcard}/g, '*')
-    .replace(/{(\w+)}/g, ':$1')
-}
-
-function updateOpenApiSchemaRefs (openapiSchema) {
-  const componentsPrefix = '#/components/schemas/'
-
-  for (const key of Object.keys(openapiSchema)) {
-    const value = openapiSchema[key]
-
-    if (key === '$ref' && value.startsWith(componentsPrefix)) {
-      openapiSchema.$ref = value
-        .replace(componentsPrefix, '')
-        .split('/', 1)
-        .join('#/')
-
-      continue
-    }
-
-    if (typeof value === 'object') {
-      updateOpenApiSchemaRefs(value)
-    }
-  }
-}
-
-function convertOpenApiToFastifyRouteSchema (openapiSchema) {
-  const routeSchema = {}
-
-  for (const openApiParam of openapiSchema.parameters ?? []) {
-    const name = openApiParam.name
-    const schema = openApiParam.schema
-
-    if (openApiParam.in === 'path') {
-      if (routeSchema.params === undefined) {
-        routeSchema.params = {
-          type: 'object',
-          properties: {},
-          required: []
-        }
-      }
-
-      routeSchema.params.properties[name] = schema
-      if (openApiParam.required) {
-        routeSchema.params.required.push(name)
-      }
-    }
-
-    if (openApiParam.in === 'header') {
-      if (routeSchema.headers === undefined) {
-        routeSchema.headers = {
-          type: 'object',
-          properties: {},
-          required: []
-        }
-      }
-
-      routeSchema.headers.properties[name] = schema
-      if (openApiParam.required) {
-        routeSchema.headers.required.push(name)
-      }
-    }
-
-    if (openApiParam.in === 'query') {
-      if (routeSchema.querystring === undefined) {
-        routeSchema.querystring = {
-          type: 'object',
-          properties: {},
-          required: []
-        }
-      }
-
-      routeSchema.querystring.properties[name] = schema
-      if (openApiParam.required) {
-        routeSchema.querystring.required.push(name)
-      }
-    }
-  }
-
-  if (openapiSchema.requestBody) {
-    const content = openapiSchema.requestBody.content
-    const contentType = Object.keys(content)[0]
-    routeSchema.body = content[contentType].schema
-  }
-
-  for (const statusCode of Object.keys(openapiSchema.responses ?? {})) {
-    const response = openapiSchema.responses[statusCode]
-    const responseSchema = response.content?.['application/json']?.schema
-    if (responseSchema) {
-      if (!routeSchema.response) {
-        routeSchema.response = {}
-      }
-      routeSchema.response[statusCode] = responseSchema
-    }
-  }
-
-  updateOpenApiSchemaRefs(routeSchema)
-
-  return routeSchema
-}
-
-function changeOpenapiSchemaPrefix (openapiSchema, oldVersionPrefix, newVersionPrefix) {
-  if (!oldVersionPrefix && !newVersionPrefix) return openapiSchema
-
-  const normalizedPaths = {}
-  for (const oldPath of Object.keys(openapiSchema.paths ?? {})) {
-    const newPath = oldVersionPrefix
-      ? oldPath.replace(oldVersionPrefix, newVersionPrefix)
-      : newVersionPrefix + oldPath
-
-    normalizedPaths[newPath] = openapiSchema.paths[oldPath]
-  }
-
-  return {
-    ...openapiSchema,
-    paths: normalizedPaths
-  }
-}
-
 let isDockerCached
 
 async function isDocker () {
@@ -221,8 +101,5 @@ module.exports = {
   isDocker,
   isFileAccessible,
   getJSPluginPath,
-  addLoggerToTheConfig,
-  changeOpenapiSchemaPrefix,
-  convertOpenApiToFastifyPath,
-  convertOpenApiToFastifyRouteSchema
+  addLoggerToTheConfig
 }

package/lib/versions/no-allow-cycles.js

@@ -0,0 +1,15 @@
+'use strict'
+
+const { version } = require('../../package.json')
+
+module.exports.migration = {
+  version: '2.0.0',
+  toVersion: version,
+  up: function (config) {
+    if (typeof config.allowCycles === 'boolean') {
+      delete config.allowCycles
+    }
+
+    return config
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.51.8",
+  "version": "2.0.0-alpha.2",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -71,7 +71,6 @@
     "mercurius": "^14.0.0",
     "minimist": "^1.2.8",
     "my-ua-parser": "^2.0.2",
-    "openapi-schema-diff": "^0.0.1",
     "ora": "^6.3.1",
     "pino": "^8.19.0",
     "pino-pretty": "^11.0.0",
@@ -79,13 +78,13 @@
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^6.9.0",
-    "@platformatic/bus": "1.51.8",
-    "@platformatic/config": "1.51.8",
-    "@platformatic/client": "1.51.8",
-    "@platformatic/generators": "1.51.8",
-    "@platformatic/utils": "1.51.8",
-    "@platformatic/scalar-theme": "1.51.8",
-    "@platformatic/telemetry": "1.51.8"
+    "@platformatic/client": "2.0.0-alpha.2",
+    "@platformatic/config": "2.0.0-alpha.2",
+    "@platformatic/generators": "2.0.0-alpha.2",
+    "@platformatic/telemetry": "2.0.0-alpha.2",
+    "@platformatic/utils": "2.0.0-alpha.2",
+    "@platformatic/scalar-theme": "2.0.0-alpha.2",
+    "@platformatic/ts-compiler": "2.0.0-alpha.2"
   },
   "standard": {
     "ignore": [