@platformatic/composer 3.4.1 → 3.5.1

package/index.js

@@ -1,214 +1,13 @@
-'use strict'
+import { create as createGateway } from '@platformatic/gateway'
 
-const deepEqual = require('fast-deep-equal')
-const ConfigManager = require('@platformatic/config')
-const { platformaticService, buildServer, buildStackable } = require('@platformatic/service')
+// eslint-disable-next-line import-x/export
+export * from '@platformatic/gateway'
 
-const { schema } = require('./lib/schema')
-const serviceProxy = require('./lib/proxy')
-const openapi = require('./lib/openapi.js')
-const graphql = require('./lib/graphql')
-const composerHook = require('./lib/composer-hook')
-const openapiGenerator = require('./lib/openapi-generator')
-const graphqlGenerator = require('./lib/graphql-generator')
-const { isSameGraphqlSchema, fetchGraphqlSubgraphs } = require('./lib/graphql-fetch')
-const { isFetchable } = require('./lib/utils')
-const { ComposerStackable } = require('./lib/stackable')
-const errors = require('./lib/errors')
-const upgrade = require('./lib/upgrade')
+// eslint-disable-next-line import-x/export
+export async function create (configOrRoot, sourceOrConfig, context) {
+  globalThis.platformatic.logger.warn(
+    '@platformatic/composer is deprecated and it will be removed in version 4.0.0, please migrate to @platformatic/gateway.'
+  )
 
-const kITC = Symbol.for('plt.runtime.itc')
-
-const EXPERIMENTAL_GRAPHQL_COMPOSER_FEATURE_MESSAGE = 'graphql composer is an experimental feature'
-
-async function platformaticComposer (app, opts) {
-  const configManager = app.platformatic.configManager
-  const config = configManager.current
-  let hasGraphqlServices, hasOpenapiServices
-
-  // When no services are specified, get the list from the runtime.
-  if (!configManager.current.composer.services?.length) {
-    const itcResponse = await globalThis[kITC]?.send('getServices')
-
-    if (itcResponse) {
-      // Remove ourself from the services
-      configManager.current.composer.services = itcResponse.services
-        .map(service => {
-          // Remove ourself
-          if (service.id === opts.context.serviceId) {
-            return null
-          }
-
-          return { id: service.id, proxy: {} }
-        })
-        .filter(f => f)
-    }
-  }
-
-  const { services } = configManager.current.composer
-
-  for (const service of services) {
-    if (!service.origin) {
-      service.origin = `http://${service.id}.plt.local`
-    }
-    if (service.openapi && !hasOpenapiServices) {
-      hasOpenapiServices = true
-    }
-    if (service.graphql && !hasGraphqlServices) {
-      hasGraphqlServices = true
-    }
-  }
-
-  if (hasOpenapiServices) {
-    app.register(openapi, config.composer)
-  }
-  app.register(serviceProxy, { ...config.composer, context: opts.context })
-  app.register(composerHook)
-  await app.register(platformaticService, { config, context: opts.context })
-
-  if (hasOpenapiServices) {
-    await app.register(openapiGenerator, config.composer)
-  }
-
-  if (hasGraphqlServices) {
-    app.log.warn(EXPERIMENTAL_GRAPHQL_COMPOSER_FEATURE_MESSAGE)
-    app.register(graphql, config.composer)
-    await app.register(graphqlGenerator, config.composer)
-  }
-
-  if (!app.hasRoute({ url: '/', method: 'GET' })) {
-    await app.register(require('./lib/root-endpoint'), config)
-  }
-
-  if (!opts.context?.isProduction) {
-    await watchServices(app, config)
-  }
+  return createGateway(configOrRoot, sourceOrConfig, context)
 }
-
-platformaticComposer[Symbol.for('skip-override')] = true
-platformaticComposer.schema = schema
-platformaticComposer.configType = 'composer'
-platformaticComposer.configManagerConfig = {
-  version: require('./package.json').version,
-  schema,
-  allowToWatch: ['.env'],
-  schemaOptions: {
-    useDefaults: true,
-    coerceTypes: true,
-    allErrors: true,
-    strict: false
-  },
-  transformConfig: platformaticService.configManagerConfig.transformConfig,
-  upgrade
-}
-
-// TODO review no need to be async
-async function buildComposerServer (options) {
-  // TODO ConfigManager is not been used, it's attached to platformaticComposer, can be removed
-  return buildServer(options, platformaticComposer, ConfigManager)
-}
-
-async function detectServicesUpdate ({ app, services, fetchOpenApiSchema, fetchGraphqlSubgraphs }) {
-  let changed
-
-  const graphqlServices = []
-  // assumes services here are fetchable
-  for (const service of services) {
-    const { id, origin, openapi, graphql } = service
-
-    if (openapi) {
-      const currentSchema = app.openApiSchemas.find(schema => schema.id === id)?.originSchema || null
-
-      let fetchedSchema = null
-      try {
-        fetchedSchema = await fetchOpenApiSchema({ origin, openapi })
-      } catch (err) {
-        app.log.error({ err }, 'failed to fetch schema (watch) for service ' + id)
-      }
-
-      if (!changed && !deepEqual(fetchedSchema, currentSchema)) {
-        changed = true
-        // it stops at first schema difference since all the schemas will be updated on reload
-        break
-      }
-    }
-
-    if (graphql) {
-      graphqlServices.push(service)
-    }
-  }
-
-  if (!changed && graphqlServices.length > 0) {
-    const graphqlSupergraph = await fetchGraphqlSubgraphs(graphqlServices, app.graphqlComposerOptions, app)
-    if (!isSameGraphqlSchema(graphqlSupergraph, app.graphqlSupergraph)) {
-      changed = true
-      app.graphqlSupergraph = graphqlSupergraph
-    }
-  }
-
-  return changed
-}
-
-/**
- * poll services to detect changes, every `opts.composer.refreshTimeout`
- * polling is disabled on refreshTimeout = 0
- * or there are no network openapi nor graphql remote services (the services are from file or they don't have a schema/graph to fetch)
- */
-async function watchServices (app, opts) {
-  const { services, refreshTimeout } = opts.composer
-  if (refreshTimeout < 1) {
-    return
-  }
-
-  const watching = services.filter(isFetchable)
-  if (watching.length < 1) {
-    return
-  }
-
-  if (!globalThis[Symbol.for('plt.runtime.id')]) {
-    app.log.warn('Watching services is only supported when running within a Platformatic Runtime.')
-    return
-  }
-
-  const { fetchOpenApiSchema } = await import('./lib/openapi-fetch-schemas.mjs')
-
-  app.log.info({ services: watching }, 'start watching services')
-
-  const timer = setInterval(async () => {
-    try {
-      if (await detectServicesUpdate({ app, services: watching, fetchOpenApiSchema, fetchGraphqlSubgraphs })) {
-        clearInterval(timer)
-        app.log.info('detected services changes, restarting ...')
-
-        globalThis[Symbol.for('plt.runtime.itc')].notify('changed')
-      }
-    } catch (error) {
-      app.log.error(
-        {
-          err: {
-            message: error.message,
-            stack: error.stack
-          }
-        },
-        'failed to get services info'
-      )
-    }
-  }, refreshTimeout).unref()
-
-  app.addHook('onClose', async () => {
-    clearInterval(timer)
-  })
-}
-
-async function buildComposerStackable (options) {
-  return buildStackable(options, platformaticComposer, ComposerStackable)
-}
-
-module.exports = platformaticComposer
-module.exports.schema = schema
-module.exports.platformaticComposer = platformaticComposer
-module.exports.buildServer = buildComposerServer
-module.exports.errors = errors
-module.exports.Generator = require('./lib/generator/composer-generator')
-module.exports.ConfigManager = ConfigManager
-module.exports.buildStackable = buildComposerStackable

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "@platformatic/composer",
-  "version": "3.4.1",
+  "version": "3.5.1",
   "description": "",
   "main": "index.js",
-  "bin": {
-    "plt-composer": "./composer.mjs"
-  },
-  "author": "Ivan Tymoshenko <ivan@tymoshenko.me>",
+  "types": "index.d.ts",
+  "type": "module",
+  "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/platformatic/platformatic.git"
@@ -17,65 +16,25 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "borp": "^0.17.0",
     "c8": "^10.0.0",
-    "dedent": "^1.5.1",
+    "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
-    "json-schema-to-typescript": "^15.0.0",
-    "neostandard": "^0.11.1",
-    "openapi-schema-validator": "^12.1.3",
-    "single-user-cache": "^1.0.1",
-    "split2": "^4.2.0",
-    "tsd": "^0.31.0",
-    "typescript": "^5.5.4",
-    "why-is-node-running": "2",
-    "ws": "^8.16.0",
-    "@platformatic/client": "3.4.1",
-    "@platformatic/config": "3.4.1",
-    "@platformatic/db": "3.4.1"
+    "neostandard": "^0.12.0",
+    "json-schema-to-typescript": "^15.0.0"
   },
   "dependencies": {
-    "@fastify/error": "^4.0.0",
-    "@fastify/http-proxy": "^10.0.0",
-    "@fastify/reply-from": "^11.0.0",
-    "@fastify/static": "^8.0.0",
-    "@fastify/swagger": "^9.0.0",
-    "@platformatic/graphql-composer": "^0.8.0",
-    "@scalar/fastify-api-reference": "^1.19.5",
-    "ajv": "^8.12.0",
-    "commist": "^3.2.0",
-    "console-table-printer": "^2.12.0",
-    "desm": "^1.3.1",
-    "es-main": "^1.3.0",
-    "execa": "^8.0.1",
-    "fast-deep-equal": "^3.1.3",
-    "fastify": "^5.0.0",
-    "fastify-openapi-glue": "^4.6.0",
-    "fastify-plugin": "^5.0.0",
-    "graphql": "^16.8.1",
-    "help-me": "^5.0.0",
-    "json-schema-traverse": "^1.0.0",
-    "mercurius": "^15.0.0",
-    "minimist": "^1.2.8",
-    "my-ua-parser": "^2.0.2",
-    "ora": "^6.3.1",
-    "pino": "^8.19.0",
-    "pino-pretty": "^11.0.0",
-    "rfdc": "^1.3.1",
-    "semgrator": "^0.3.0",
-    "undici": "^6.9.0",
-    "@platformatic/config": "3.4.1",
-    "@platformatic/scalar-theme": "3.4.1",
-    "@platformatic/generators": "3.4.1",
-    "@platformatic/service": "3.4.1",
-    "@platformatic/telemetry": "3.4.1",
-    "@platformatic/utils": "^3.4.1"
+    "@platformatic/foundation": "3.5.1",
+    "@platformatic/gateway": "3.5.1"
+  },
+  "engines": {
+    "node": ">=22.19.0"
   },
   "scripts": {
-    "test": "pnpm run lint && borp -T --timeout=180000 -c 1 && tsd",
-    "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",
-    "lint": "eslint"
+    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js",
+    "prebuild": "cd ../gateway && npm run build",
+    "build": "node scripts/schema.js",
+    "lint": "eslint",
+    "gen-schema": "node scripts/schema.js > schema.json",
+    "gen-types": "json2ts > config.d.ts < schema.json"
   }
 }