@platformatic/service 2.72.0 → 3.0.0-alpha.1

package/lib/generator.js

@@ -0,0 +1,154 @@
+import { BaseGenerator } from '@platformatic/generators'
+
+export class Generator extends BaseGenerator {
+  constructor (opts = {}) {
+    super({
+      ...opts,
+      module: '@platformatic/service'
+    })
+  }
+
+  getDefaultConfig () {
+    const config = super.getDefaultConfig()
+    config.plugin = true
+    config.tests = true
+    return config
+  }
+
+  async _beforePrepare () {
+    // if we are NOT updating, create env and files, otherwise leave as it is
+    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 }
+        )
+      }
+
+      this.addEnvVars(
+        {
+          PLT_TYPESCRIPT: this.config.typescript
+        },
+        { overwrite: false, default: true }
+      )
+
+      this.config.dependencies = {
+        '@platformatic/service': `^${this.platformaticVersion}`
+      }
+    }
+  }
+
+  getConfigFieldsDefinitions () {
+    if (this.config.isRuntimeContext) {
+      return []
+    }
+    return [
+      {
+        var: 'PLT_SERVER_HOSTNAME',
+        label: 'What is the hostname?',
+        default: '0.0.0.0',
+        type: 'string',
+        configValue: 'hostname'
+      },
+      {
+        var: 'PLT_SERVER_LOGGER_LEVEL',
+        label: 'What is the logger level?',
+        default: 'info',
+        type: 'string',
+        configValue: ''
+      },
+      {
+        label: 'Which port do you want to use?',
+        var: 'PORT',
+        default: 3042,
+        type: 'number',
+        configValue: 'port'
+      }
+    ]
+  }
+
+  async _afterPrepare () {
+    // if we are NOT updating, create env and files, otherwise leave as it is
+    if (!this.config.isUpdating) {
+      const PLT_ENVIRONMENT_TEMPLATE = `
+import { FastifyInstance } from 'fastify'
+import { PlatformaticApplication, PlatformaticServiceConfig } from '@platformatic/service'
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    platformatic: PlatformaticApplication<PlatformaticServiceConfig>
+  }
+}
+`
+
+      const README = `
+# Platformatic Service API
+
+This is a generated [Platformatic Service](https://docs.platformatic.dev/docs/service/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
+
+Install dependencies:
+
+\`\`\`bash
+npm install
+\`\`\`
+
+## Usage
+
+Run the API with:
+
+\`\`\`bash
+npm start
+\`\`\`
+
+### Explore
+- ⚡ The Platformatic DB server is running at http://localhost:3042/
+- 📔 View the REST API's Swagger documentation at http://localhost:3042/documentation/
+- 🔍 Try out the GraphiQL web UI at http://localhost:3042/graphiql
+`
+
+      this.addFile({ path: '', file: 'plt-env.d.ts', contents: PLT_ENVIRONMENT_TEMPLATE })
+      this.addFile({ path: '', file: 'README.md', contents: README })
+    }
+  }
+
+  async _getConfigFileContents () {
+    const { isRuntimeContext } = this.config
+    const version = this.platformaticVersion
+    const config = {
+      $schema: `https://schemas.platformatic.dev/@platformatic/service/${version}.json`,
+      service: {
+        openapi: true
+      },
+      watch: true
+    }
+    if (this.config.plugin) {
+      config.plugins = {
+        paths: [{ path: './plugins', encapsulate: false }, './routes'],
+        typescript: `{${this.getEnvVarName('PLT_TYPESCRIPT')}}`
+      }
+    }
+
+    if (!isRuntimeContext) {
+      config.server = {
+        hostname: '{PLT_SERVER_HOSTNAME}',
+        port: '{PORT}',
+        logger: {
+          level: '{PLT_SERVER_LOGGER_LEVEL}'
+        }
+      }
+    }
+
+    return config
+  }
+}

package/lib/plugins/clients.js

@@ -1,16 +1,17 @@
-'use strict'
-
-const fp = require('fastify-plugin')
-const client = require('@platformatic/client')
-
-async function setupClients (app, opts) {
+import client from '@platformatic/client'
+import { kMetadata } from '@platformatic/utils'
+import fp from 'fastify-plugin'
+import { createRequire } from 'node:module'
+import { resolve } from 'node:path'
+async function setupClientsPlugin (app, opts) {
   for (const { path, url, serviceId, name, schema, type, fullRequest, fullResponse, validateResponse } of opts) {
     if (path) {
-      app.register(require(path), { url, serviceId })
+      const require = createRequire(resolve(app.platformatic.config[kMetadata].root, 'noop.js'))
+      app.register(await require(path), { url, serviceId })
     } else {
       app.register(client, { url, serviceId, name, path: schema, type, fullRequest, fullResponse, validateResponse })
     }
   }
 }
 
-module.exports = fp(setupClients)
+export const setupClients = fp(setupClientsPlugin)

package/lib/plugins/cors.js

@@ -1,6 +1,5 @@
-'use strict'
-
-const fp = require('fastify-plugin')
+import fastifyCors from '@fastify/cors'
+import fp from 'fastify-plugin'
 
 function originToRegexp (origin) {
   if (typeof origin === 'object') {
@@ -12,9 +11,7 @@ function originToRegexp (origin) {
   return origin
 }
 
-async function setupClients (app, opts) {
-  const cors = opts
-
+async function setupCorsPlugin (app, cors) {
   let origin = cors.origin
   if (Array.isArray(origin)) {
     origin = origin.map(originToRegexp)
@@ -23,7 +20,7 @@ async function setupClients (app, opts) {
   }
 
   cors.origin = origin
-  app.register(require('@fastify/cors'), cors)
+  app.register(fastifyCors, cors)
 }
 
-module.exports = fp(setupClients)
+export const setupCors = fp(setupCorsPlugin)

package/lib/plugins/graphql.js

@@ -1,24 +1,26 @@
-'use strict'
-
-const mercurius = require('mercurius')
-const deepmerge = require('@fastify/deepmerge')({ all: true })
-const fp = require('fastify-plugin')
+import { deepmerge } from '@platformatic/utils'
+import fp from 'fastify-plugin'
+import mercurius from 'mercurius'
 
 // For some unknown reason, c8 is not detecting any of this
 // despite being covered by test/graphql.test.js
 /* c8 ignore next 12 */
-async function setupGraphQL (app, opts) {
-  if (typeof opts !== 'object') {
-    opts = {}
+async function setupGraphQLPlugin (app, options) {
+  if (typeof options !== 'object') {
+    options = {}
   }
-  const graphqlOptions = deepmerge({
-    graphiql: true,
-    additionalRouteOptions: {
-      schema: { hide: true },
+
+  const graphqlOptions = deepmerge(
+    {
+      graphiql: true,
+      additionalRouteOptions: {
+        schema: { hide: true }
+      }
     },
-  }, opts)
+    options
+  )
 
   app.register(mercurius, graphqlOptions)
 }
 
-module.exports = fp(setupGraphQL)
+export const setupGraphQL = fp(setupGraphQLPlugin)

package/lib/plugins/health-check.js

@@ -1,17 +1,15 @@
-'use strict'
+import underPressure from '@fastify/under-pressure'
+import fp from 'fastify-plugin'
 
-const underPressure = require('@fastify/under-pressure')
-const fp = require('fastify-plugin')
-
-async function setupClients (app, opts) {
-  const healthCheck = opts
+async function setupHealthCheckPlugin (app, options) {
+  const healthCheck = options
 
   app.register(underPressure, {
     exposeStatusRoute: '/status',
     healthCheckInterval: healthCheck.interval !== undefined ? healthCheck.interval : 5000,
     ...healthCheck,
-    healthCheck: healthCheck.fn,
+    healthCheck: healthCheck.fn
   })
 }
 
-module.exports = fp(setupClients)
+export const setupHealthCheck = fp(setupHealthCheckPlugin)

package/lib/plugins/openapi.js

@@ -1,43 +1,44 @@
-'use strict'
-
-const Swagger = require('@fastify/swagger')
-const deepmerge = require('@fastify/deepmerge')({ all: true })
-const fp = require('fastify-plugin')
+import Swagger from '@fastify/swagger'
+import { deepmerge } from '@platformatic/utils'
+import fp from 'fastify-plugin'
 
 // For some unknown reason, c8 is not detecting any of this
 // pf
 // despite being covered by test/routes.test.js
 /* c8 ignore next 33 */
-async function setupOpenAPI (app, opts) {
-  const { openapi } = opts
-  const openapiConfig = deepmerge({
-    exposeRoute: true,
-    info: {
-      title: 'Platformatic',
-      description: 'This is a service built on top of Platformatic',
-      version: '1.0.0',
+async function setupOpenAPIPlugin (app, options) {
+  const { openapi } = options
+  const openapiConfig = deepmerge(
+    {
+      exposeRoute: true,
+      info: {
+        title: 'Platformatic',
+        description: 'This is a service built on top of Platformatic',
+        version: '1.0.0'
+      },
+      servers: [{ url: globalThis.platformatic?.runtimeBasePath ?? '/' }]
     },
-    servers: [{ url: globalThis.platformatic?.runtimeBasePath ?? '/' }],
-  }, typeof openapi === 'object' ? openapi : {})
+    typeof openapi === 'object' ? openapi : {}
+  )
   app.log.trace({ openapi: openapiConfig })
   const swaggerOptions = {
     exposeRoute: openapiConfig.exposeRoute,
     openapi: {
-      ...openapiConfig,
+      ...openapiConfig
     },
     refResolver: {
       buildLocalReference (json, baseUri, fragment, i) {
         // TODO figure out if we need def-${i}
         /* istanbul ignore next */
         return json.$id || `def-${i}`
-      },
-    },
+      }
+    }
   }
 
   if (openapi.path) {
     swaggerOptions.mode = 'static'
     swaggerOptions.specification = {
-      path: openapi.path,
+      path: openapi.path
     }
   }
 
@@ -49,24 +50,32 @@ async function setupOpenAPI (app, opts) {
   const routePrefix = openapi.swaggerPrefix || '/documentation'
 
   /** Serve spec file in yaml and json */
-  app.get(`${routePrefix}/json`, {
-    schema: { hide: true },
-    logLevel: 'warn',
-  }, async () => app.swagger())
-  app.get(`${routePrefix}/yaml`, {
-    schema: { hide: true },
-    logLevel: 'warn',
-  }, async () => app.swagger({ yaml: true }))
+  app.get(
+    `${routePrefix}/json`,
+    {
+      schema: { hide: true },
+      logLevel: 'warn'
+    },
+    async () => app.swagger()
+  )
+  app.get(
+    `${routePrefix}/yaml`,
+    {
+      schema: { hide: true },
+      logLevel: 'warn'
+    },
+    async () => app.swagger({ yaml: true })
+  )
 
   app.register(scalarApiReference, {
-    ...opts,
+    ...options,
     ...openapi,
     routePrefix,
     publicPath: './',
     configuration: {
-      customCss: scalarTheme.theme,
-    },
+      customCss: scalarTheme.theme
+    }
   })
 }
 
-module.exports = fp(setupOpenAPI)
+export const setupOpenAPI = fp(setupOpenAPIPlugin)

package/lib/plugins/plugins.js

@@ -1,21 +1,18 @@
-'use strict'
+import { kMetadata } from '@platformatic/utils'
+import fp from 'fastify-plugin'
+import { readFile } from 'node:fs/promises'
+import { join, resolve } from 'node:path'
+import { getJSPluginPath, isFileAccessible } from '../utils.js'
+import { sandboxWrapper } from './sandbox-wrapper.js'
 
-const { join, resolve } = require('path')
-const { readFile } = require('fs/promises')
-const fp = require('fastify-plugin')
-const wrapper = require('./sandbox-wrapper')
-
-const { getJSPluginPath, isFileAccessible } = require('../utils')
-
-async function loadPlugins (app, opts) {
-  const configManager = app.platformatic.configManager
-  const config = configManager.current
+async function loadPluginsPlugin (app, context) {
+  const config = app.platformatic.config
 
   let isOutDirAccessible = false
   let outDir = null
 
-  const workingDir = opts?.context?.directory ?? configManager.dirname
-  const tsConfigPath = configManager.current.plugins.typescript?.tsConfig || join(workingDir, 'tsconfig.json')
+  const workingDir = context?.directory ?? config[kMetadata].root
+  const tsConfigPath = config.plugins.typescript?.tsConfig || join(workingDir, 'tsconfig.json')
 
   // If the tsconfig.json file exists, then we need to adjust the plugin paths
   // to point to the compiled JS files.
@@ -26,14 +23,14 @@ async function loadPlugins (app, opts) {
   }
 
   /* c8 ignore next 3 */
-  if (configManager.current.plugins.typescript?.outDir) {
-    outDir = configManager.current.plugins.typescript.outDir
+  if (config.plugins.typescript?.outDir) {
+    outDir = config.plugins.typescript.outDir
   }
 
   if (outDir) {
     isOutDirAccessible = await isFileAccessible(outDir)
 
-    if (opts.context?.isProduction && !isOutDirAccessible) {
+    if (context?.isProduction && !isOutDirAccessible) {
       throw new Error(
         `Cannot access directory '${outDir}'. Please run the 'build' command before running in production mode.`
       )
@@ -51,7 +48,7 @@ async function loadPlugins (app, opts) {
     })
   }
 
-  await app.register(wrapper, { packages: config.plugins.packages, paths: config.plugins.paths })
+  await app.register(sandboxWrapper, { packages: config.plugins.packages, paths: config.plugins.paths })
 }
 
-module.exports = fp(loadPlugins)
+export const loadPlugins = fp(loadPluginsPlugin)

package/lib/{root-endpoint/index.js → plugins/root.js}

@@ -1,12 +1,11 @@
-'use strict'
+import fastifyStatic from '@fastify/static'
+import fp from 'fastify-plugin'
+import userAgentParser from 'my-ua-parser'
+import { join } from 'node:path'
 
-const path = require('path')
-const fastifyStatic = require('@fastify/static')
-const userAgentParser = require('my-ua-parser')
-
-module.exports = async (app, opts) => {
+async function setupRootPlugin (app) {
   app.register(fastifyStatic, {
-    root: path.join(__dirname, 'public'),
+    root: join(import.meta.dirname, '../../public')
   })
 
   // root endpoint
@@ -23,6 +22,8 @@ module.exports = async (app, opts) => {
         }
       }
       return { message: 'Welcome to Platformatic! Please visit https://docs.platformatic.dev' }
-    },
+    }
   })
 }
+
+export const setupRoot = fp(setupRootPlugin)

package/lib/plugins/sandbox-wrapper.js

@@ -1,26 +1,75 @@
-'use strict'
+import autoload from '@fastify/autoload'
+import { kMetadata } from '@platformatic/utils'
+import fp from 'fastify-plugin'
+import { stat } from 'node:fs/promises'
+import { createRequire } from 'node:module'
+import { isAbsolute, resolve } from 'node:path'
+import { pathToFileURL } from 'node:url'
 
-const fp = require('fastify-plugin')
-const autoload = require('@fastify/autoload')
-const { stat } = require('node:fs/promises')
-const { createRequire } = require('node:module')
-const { join } = require('node:path')
-const { pathToFileURL } = require('node:url')
+/**
+ * Creates an object for pattern specific options. This ensures that
+ * only configurations that have been provided are included in the
+ * final result. This prevents 'cannot read properties of undefined'
+ * errors when undefined configs are provided to the underlying
+ * @fastify/autoload plugin.
+ */
+function patternOptionsFromPlugin (plugin) {
+  const config = {}
+
+  // Expected keys for autoload plugin options that expect regexp patterns
+  const patternOptionKeys = ['ignorePattern', 'indexPattern', 'autoHooksPattern']
 
-module.exports = fp(async function (app, opts) {
+  for (const key of patternOptionKeys) {
+    const pattern = plugin[key]
+
+    // If pattern key not found in plugin object, move on
+    if (!pattern) {
+      continue
+    }
+
+    // Build an instance of a RegExp. If this comes back undefined,
+    // then an invalid value was provided. Move on.
+    const regExpPattern = stringPatternToRegExp(pattern)
+    if (!regExpPattern) {
+      continue
+    }
+
+    // We have a valid RegExp so add the option to the config to pass along to
+    // autoload.
+    config[key] = regExpPattern
+  }
+
+  return config
+}
+
+function stringPatternToRegExp (stringPattern) {
+  try {
+    return new RegExp(stringPattern)
+  } catch (err) {
+    return undefined
+  }
+}
+
+async function sandboxWrapperPlugin (app, options) {
   // fake require next to the configManager dirname
-  const _require = createRequire(join(app.platformatic.configManager.dirname, 'package.json'))
-  for (const plugin of opts.packages || []) {
+  const require = createRequire(resolve(app.platformatic.config[kMetadata].root, 'noop.js'))
+
+  for (const plugin of options.packages || []) {
     const name = typeof plugin === 'string' ? plugin : plugin.name
-    const url = pathToFileURL(_require.resolve(name))
+    const url = pathToFileURL(require.resolve(name))
     const loaded = await import(url)
     await app.register(loaded, plugin.options)
   }
 
-  for (let plugin of opts.paths || []) {
+  for (let plugin of options.paths || []) {
     if (typeof plugin === 'string') {
       plugin = { path: plugin, encapsulate: true }
     }
+
+    if (plugin.path && !isAbsolute(plugin.path)) {
+      plugin.path = resolve(app.platformatic.config[kMetadata].root, plugin.path)
+    }
+
     if (plugin.path && (await stat(plugin.path)).isDirectory()) {
       const patternOptions = patternOptionsFromPlugin(plugin)
 
@@ -55,48 +104,6 @@ module.exports = fp(async function (app, opts) {
       }
     }
   }
-})
-
-/**
- * Creates an object for pattern specific options. This ensures that
- * only configurations that have been provided are included in the
- * final result. This prevents 'cannot read properties of undefined'
- * errors when undefined configs are provided to the underlying
- * @fastify/autoload plugin.
- */
-function patternOptionsFromPlugin (plugin) {
-  const config = {}
-
-  // Expected keys for autoload plugin options that expect regexp patterns
-  const patternOptionKeys = ['ignorePattern', 'indexPattern', 'autoHooksPattern']
-
-  for (const key of patternOptionKeys) {
-    const pattern = plugin[key]
-
-    // If pattern key not found in plugin object, move on
-    if (!pattern) {
-      continue
-    }
-
-    // Build an instance of a RegExp. If this comes back undefined,
-    // then an invalid value was provided. Move on.
-    const regExpPattern = stringPatternToRegExp(pattern)
-    if (!regExpPattern) {
-      continue
-    }
-
-    // We have a valid RegExp so add the option to the config to pass along to
-    // autoload.
-    config[key] = regExpPattern
-  }
-
-  return config
 }
 
-function stringPatternToRegExp (stringPattern) {
-  try {
-    return new RegExp(stringPattern)
-  } catch (err) {
-    return undefined
-  }
-}
+export const sandboxWrapper = fp(sandboxWrapperPlugin)

package/lib/plugins/typescript.js

@@ -1,20 +1,17 @@
-'use strict'
+import compiler from '@platformatic/ts-compiler'
+import { kMetadata } from '@platformatic/utils'
+import fp from 'fastify-plugin'
 
-const fp = require('fastify-plugin')
-const compiler = require('@platformatic/ts-compiler')
-const { extractTypeScriptCompileOptionsFromConfig } = require('../compile')
-
-async function setupTsCompiler (app, opts) {
-  const configManager = app.platformatic.configManager
-  const config = configManager.current
-  const workingDir = opts?.context?.directory ?? configManager.dirname
+async function setupTsCompilerPlugin (app, context) {
+  const config = app.platformatic.config
 
   await compiler.compile({
-    ...extractTypeScriptCompileOptionsFromConfig(config),
-    cwd: workingDir,
+    tsConfig: config.plugins?.typescript?.tsConfig,
+    flags: config.plugins?.typescript?.flags,
+    cwd: context?.directory ?? config[kMetadata].root,
     clean: false,
-    logger: app.log,
+    logger: app.log
   })
 }
 
-module.exports = fp(setupTsCompiler)
+export const setupTsCompiler = fp(setupTsCompilerPlugin)