@platformatic/composer 2.74.3 → 3.0.0-alpha.2

package/lib/errors.js

@@ -1,13 +1,18 @@
-'use strict'
-
-const createError = require('@fastify/error')
+import createError from '@fastify/error'
 
 const ERROR_PREFIX = 'PLT_COMPOSER'
 
-module.exports = {
-  FastifyInstanceIsAlreadyListeningError: createError(`${ERROR_PREFIX}_FASTIFY_INSTANCE_IS_ALREADY_LISTENING`, 'Fastify instance is already listening. Cannot call "addComposerOnRouteHook"!'),
-  FailedToFetchOpenAPISchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_FETCH_OPENAPI_SCHEMA`, 'Failed to fetch OpenAPI schema from %s'),
-  ValidationErrors: createError(`${ERROR_PREFIX}_VALIDATION_ERRORS`, 'Validation errors: %s'),
-  PathAlreadyExistsError: createError(`${ERROR_PREFIX}_PATH_ALREADY_EXISTS`, 'Path "%s" already exists'),
-  CouldNotReadOpenAPIConfigError: createError(`${ERROR_PREFIX}_COULD_NOT_READ_OPENAPI_CONFIG`, 'Could not read openapi config for "%s" service'),
-}
+export const FastifyInstanceIsAlreadyListeningError = createError(
+  `${ERROR_PREFIX}_FASTIFY_INSTANCE_IS_ALREADY_LISTENING`,
+  'Fastify instance is already listening. Cannot call "addComposerOnRouteHook"!'
+)
+export const FailedToFetchOpenAPISchemaError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_FETCH_OPENAPI_SCHEMA`,
+  'Failed to fetch OpenAPI schema from %s'
+)
+export const ValidationErrors = createError(`${ERROR_PREFIX}_VALIDATION_ERRORS`, 'Validation errors: %s')
+export const PathAlreadyExistsError = createError(`${ERROR_PREFIX}_PATH_ALREADY_EXISTS`, 'Path "%s" already exists')
+export const CouldNotReadOpenAPIConfigError = createError(
+  `${ERROR_PREFIX}_COULD_NOT_READ_OPENAPI_CONFIG`,
+  'Could not read openapi config for "%s" service'
+)

package/lib/generator.js

@@ -0,0 +1,127 @@
+import { Generator as ServiceGenerator } from '@platformatic/service'
+
+export class Generator extends ServiceGenerator {
+  constructor (opts) {
+    super({
+      ...opts,
+      module: '@platformatic/composer'
+    })
+  }
+
+  getDefaultConfig () {
+    const defaultBaseConfig = super.getDefaultConfig()
+
+    return {
+      ...defaultBaseConfig,
+      plugin: false,
+      routes: false,
+      tests: false
+    }
+  }
+
+  async _beforePrepare () {
+    if (this.config.isUpdating) {
+      return
+    }
+
+    await super._beforePrepare()
+
+    this.addEnvVars(
+      {
+        PLT_EXAMPLE_ORIGIN: 'http://127.0.0.1:3043'
+      },
+      { overwrite: false, default: true }
+    )
+
+    this.config.dependencies = {
+      '@platformatic/composer': `^${this.platformaticVersion}`
+    }
+  }
+
+  async _afterPrepare () {
+    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' {
+  interface FastifyInstance {
+    platformatic: PlatformaticApplication<PlatformaticComposerConfig>
+  }
+}
+`
+
+    const README = `
+# Platformatic Composer API
+
+This is a generated [Platformatic Composer](https://docs.platformatic.dev/docs/composer/overview) application.
+
+## Requirements
+
+Platformatic supports macOS, Linux and Windows ([WSL](https://docs.microsoft.com/windows/wsl/) recommended).
+You'll need to have [Node.js](https://nodejs.org/) >= v18.8.0 or >= v20.6.0
+
+## Setup
+
+1. Install dependencies:
+
+\`\`\`bash
+npm install
+\`\`\`
+
+## Usage
+
+Run the API with:
+
+\`\`\`bash
+npm start
+\`\`\`
+
+### Explore
+- ⚡ The Platformatic Composer server is running at http://localhost:3042/
+- 📔 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 })
+  }
+
+  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/graphql-fetch.js

@@ -1,49 +1,7 @@
-'use strict'
-
-const { compose } = require('@platformatic/graphql-composer')
+import { compose } from '@platformatic/graphql-composer'
 
 const placeholderSdl = 'Query { _info: String }'
-const placeholderResolvers = { Query: { _info: 'platformatic composer' } }
-
-function createSupergraph ({ sdl = null, resolvers = {} } = {}) {
-  // in case of temporary failures of subgraphs on watching, the service can restart if no subgraphs are (tempoary) available
-  if (!sdl) {
-    return {
-      sdl: placeholderSdl,
-      resolvers: placeholderResolvers,
-    }
-  }
-  return { sdl, resolvers }
-}
-
-function isSameGraphqlSchema (a, b) {
-  // TODO review
-  return a?.sdl === b?.sdl
-}
-
-function serviceToSubgraphConfig (service) {
-  if (!service.graphql) { return }
-  return {
-    name: service.graphql.name || service.id || service.origin,
-    entities: service.graphql.entities,
-    server: {
-      host: service.graphql.host || service.origin,
-      composeEndpoint: service.graphql.composeEndpoint,
-      graphqlEndpoint: service.graphql.graphqlEndpoint,
-    },
-  }
-}
-
-async function fetchGraphqlSubgraphs (services, options, app) {
-  const subgraphs = services.map(serviceToSubgraphConfig).filter(s => !!s)
-  const composer = await compose({ ...toComposerOptions(options, app), subgraphs })
-
-  return createSupergraph({
-    logger: app.log,
-    sdl: composer.toSdl(),
-    resolvers: composer.resolvers,
-  })
-}
+const placeholderResolvers = { Query: { _info: '@platformatic/composer' } }
 
 // TODO support subscriptions
 // const defaultSubscriptionsOptions = {
@@ -78,8 +36,48 @@ function toComposerOptions (options, app) {
           app.log.error({ err }, 'running onSubgraphError')
         }
       }
-    },
+    }
   }
 }
 
-module.exports = { fetchGraphqlSubgraphs, createSupergraph, isSameGraphqlSchema, serviceToSubgraphConfig }
+export function createSupergraph ({ sdl = null, resolvers = {} } = {}) {
+  // in case of temporary failures of subgraphs on watching, the service can restart if no subgraphs are (tempoary) available
+  if (!sdl) {
+    return {
+      sdl: placeholderSdl,
+      resolvers: placeholderResolvers
+    }
+  }
+  return { sdl, resolvers }
+}
+
+export function isSameGraphqlSchema (a, b) {
+  // TODO review
+  return a?.sdl === b?.sdl
+}
+
+export function serviceToSubgraphConfig (service) {
+  if (!service.graphql) {
+    return
+  }
+  return {
+    name: service.graphql.name || service.id || service.origin,
+    entities: service.graphql.entities,
+    server: {
+      host: service.graphql.host || service.origin,
+      composeEndpoint: service.graphql.composeEndpoint,
+      graphqlEndpoint: service.graphql.graphqlEndpoint
+    }
+  }
+}
+
+export async function fetchGraphqlSubgraphs (services, options, app) {
+  const subgraphs = services.map(serviceToSubgraphConfig).filter(s => !!s)
+  const composer = await compose({ ...toComposerOptions(options, app), subgraphs })
+
+  return createSupergraph({
+    logger: app.log,
+    sdl: composer.toSdl(),
+    resolvers: composer.resolvers
+  })
+}

package/lib/graphql-generator.js

@@ -1,21 +1,23 @@
-'use strict'
+import fp from 'fastify-plugin'
+import mercurius from 'mercurius'
+import { fetchGraphqlSubgraphs } from './graphql-fetch.js'
 
-const fp = require('fastify-plugin')
-const mercurius = require('mercurius')
-const { fetchGraphqlSubgraphs } = require('./graphql-fetch')
-
-async function composeGraphql (app, opts) {
-  if (!opts.services.some(s => s.graphql)) { return }
+async function graphqlGeneratorPlugin (app, opts) {
+  if (!opts.services.some(s => s.graphql)) {
+    return
+  }
 
   const services = []
 
   for (const service of opts.services) {
-    if (!service.graphql) { continue }
+    if (!service.graphql) {
+      continue
+    }
     services.push(service)
   }
 
   const graphqlConfig = {
-    graphiql: opts.graphql?.graphiql,
+    graphiql: opts.graphql?.graphiql
   }
   if (services.length > 0) {
     const graphqlSupergraph = await fetchGraphqlSubgraphs(services, opts.graphql, app)
@@ -28,4 +30,4 @@ async function composeGraphql (app, opts) {
   await app.register(mercurius, graphqlConfig)
 }
 
-module.exports = fp(composeGraphql)
+export const graphqlGenerator = fp(graphqlGeneratorPlugin)

package/lib/graphql.js

@@ -1,20 +1,24 @@
-'use strict'
-
-const fp = require('fastify-plugin')
-const { createSupergraph } = require('./graphql-fetch')
+import fp from 'fastify-plugin'
+import { createSupergraph } from './graphql-fetch.js'
 
 const graphqlSupergraphSymbol = Symbol('graphqlSupergraph')
 
-async function composeGraphql (app, opts) {
+export async function graphqlPlugin (app, opts) {
   app.decorate('graphqlSupergraph', {
-    getter () { return this[graphqlSupergraphSymbol] },
-    setter (v) { this[graphqlSupergraphSymbol] = v },
+    getter () {
+      return this[graphqlSupergraphSymbol]
+    },
+    setter (v) {
+      this[graphqlSupergraphSymbol] = v
+    }
   })
   app.decorate('graphqlComposerOptions', {
-    getter () { return opts },
+    getter () {
+      return opts
+    }
   })
 
   app.graphqlSupergraph = createSupergraph()
 }
 
-module.exports = fp(composeGraphql)
+export const graphql = fp(graphqlPlugin)

package/lib/{proxy/not-host-constraints.js → not-host-constraints.js}

@@ -1,8 +1,6 @@
-'use strict'
-
-module.exports = {
+export const notHostConstraints = {
   name: 'notHost',
-  storage: () => {
+  storage () {
     const store = []
 
     return {
@@ -23,7 +21,7 @@ module.exports = {
       store
     }
   },
-  deriveConstraint: req => {
+  deriveConstraint (req) {
     return req.headers.host || req.headers[':authority']
   },
   mustMatchWhenDerived: false,

package/lib/openapi-composer.js

@@ -1,9 +1,40 @@
-'use strict'
+import rfdc from 'rfdc'
+import { PathAlreadyExistsError } from './errors.js'
 
-const clone = require('rfdc')()
-const errors = require('./errors')
+const clone = rfdc()
 
-function composeOpenApi (apis, options = {}) {
+function generateOperationIdApiPrefix (operationId) {
+  return (
+    operationId
+      .trim()
+      .replace(/[^A-Z0-9]+/gi, '_')
+      .replace(/^_+|_+$/g, '') + '_'
+  )
+}
+
+function namespaceSchemaRefs (apiPrefix, schema) {
+  if (schema.$ref && schema.$ref.startsWith('#/components/schemas')) {
+    schema.$ref = schema.$ref.replace('#/components/schemas/', '#/components/schemas/' + apiPrefix)
+  }
+  for (const childSchema of Object.values(schema)) {
+    if (typeof childSchema === 'object') {
+      namespaceSchemaRefs(apiPrefix, childSchema)
+    }
+  }
+}
+
+function namespaceSchemaOperationIds (apiPrefix, schema) {
+  if (schema.operationId) {
+    schema.operationId = apiPrefix + schema.operationId
+  }
+  for (const childSchema of Object.values(schema)) {
+    if (typeof childSchema === 'object') {
+      namespaceSchemaOperationIds(apiPrefix, childSchema)
+    }
+  }
+}
+
+export function composeOpenApi (apis, options = {}) {
   const mergedPaths = {}
   const mergedSchemas = {}
   const mergedSecuritySchemes = {}
@@ -31,7 +62,7 @@ function composeOpenApi (apis, options = {}) {
       const mergedPath = prefix ? prefix + path : path
 
       if (mergedPaths[mergedPath]) {
-        throw new errors.PathAlreadyExistsError(mergedPath)
+        throw new PathAlreadyExistsError(mergedPath)
       }
       mergedPaths[mergedPath] = pathSchema
     }
@@ -59,45 +90,12 @@ function composeOpenApi (apis, options = {}) {
     openapi: '3.0.0',
     info: {
       title: options.title || 'Platformatic Composer',
-      version: options.version || '1.0.0',
+      version: options.version || '1.0.0'
     },
     components: {
       securitySchemes: mergedSecuritySchemes,
-      schemas: mergedSchemas,
+      schemas: mergedSchemas
     },
-    paths: mergedPaths,
+    paths: mergedPaths
   }
 }
-
-function generateOperationIdApiPrefix (operationId) {
-  return operationId.trim()
-    .replace(/[^A-Z0-9]+/ig, '_')
-    .replace(/^_+|_+$/g, '') + '_'
-}
-
-function namespaceSchemaRefs (apiPrefix, schema) {
-  if (schema.$ref && schema.$ref.startsWith('#/components/schemas')) {
-    schema.$ref = schema.$ref.replace(
-      '#/components/schemas/',
-      '#/components/schemas/' + apiPrefix
-    )
-  }
-  for (const childSchema of Object.values(schema)) {
-    if (typeof childSchema === 'object') {
-      namespaceSchemaRefs(apiPrefix, childSchema)
-    }
-  }
-}
-
-function namespaceSchemaOperationIds (apiPrefix, schema) {
-  if (schema.operationId) {
-    schema.operationId = apiPrefix + schema.operationId
-  }
-  for (const childSchema of Object.values(schema)) {
-    if (typeof childSchema === 'object') {
-      namespaceSchemaOperationIds(apiPrefix, childSchema)
-    }
-  }
-}
-
-module.exports = composeOpenApi

package/lib/openapi-config-schema.js

@@ -1,18 +1,16 @@
-'use strict'
-
 const ignoreSchema = {
   type: 'object',
   properties: {
-    ignore: { type: 'boolean' },
+    ignore: { type: 'boolean' }
   },
-  additionalProperties: false,
+  additionalProperties: false
 }
 
 const aliasSchema = {
   type: 'object',
   properties: {
-    alias: { type: 'string' },
-  },
+    alias: { type: 'string' }
+  }
 }
 
 const jsonSchemaSchema = {
@@ -28,16 +26,16 @@ const jsonSchemaSchema = {
           {
             type: 'object',
             properties: {
-              rename: { type: 'string' },
+              rename: { type: 'string' }
             },
-            additionalProperties: false,
-          },
-        ],
-      },
+            additionalProperties: false
+          }
+        ]
+      }
     },
-    items: { $ref: 'json-schema' },
+    items: { $ref: 'json-schema' }
   },
-  additionalProperties: false,
+  additionalProperties: false
 }
 
 const routeSchema = {
@@ -49,15 +47,15 @@ const routeSchema = {
         responses: {
           type: 'object',
           properties: {
-            200: { $ref: 'json-schema' },
-          },
-        },
-      },
-    },
-  ],
+            200: { $ref: 'json-schema' }
+          }
+        }
+      }
+    }
+  ]
 }
 
-const openApiConfigSchema = {
+export const openApiConfigSchema = {
   type: 'object',
   properties: {
     paths: {
@@ -76,18 +74,16 @@ const openApiConfigSchema = {
               delete: routeSchema,
               options: routeSchema,
               head: routeSchema,
-              trace: routeSchema,
+              trace: routeSchema
             },
-            additionalProperties: false,
-          },
-        ],
-      },
-    },
+            additionalProperties: false
+          }
+        ]
+      }
+    }
   },
   additionalProperties: false,
   definitions: {
-    'json-schema': jsonSchemaSchema,
-  },
+    'json-schema': jsonSchemaSchema
+  }
 }
-
-module.exports = openApiConfigSchema