@platformatic/service 1.53.3 → 2.0.0-alpha.10

package/lib/plugins/graphql.js

@@ -14,8 +14,8 @@ async function setupGraphQL (app, opts) {
   const graphqlOptions = deepmerge({
     graphiql: true,
     additionalRouteOptions: {
-      schema: { hide: true }
-    }
+      schema: { hide: true },
+    },
   }, opts)
 
   app.register(mercurius, graphqlOptions)

package/lib/plugins/health-check.js

@@ -10,7 +10,7 @@ async function setupClients (app, opts) {
     exposeStatusRoute: '/status',
     healthCheckInterval: healthCheck.interval !== undefined ? healthCheck.interval : 5000,
     ...healthCheck,
-    healthCheck: healthCheck.fn
+    healthCheck: healthCheck.fn,
   })
 }
 

package/lib/plugins/metrics.js

@@ -13,43 +13,40 @@ const metricsPlugin = fp(async function (app, opts = {}) {
 
   const defaultMetrics = opts.defaultMetrics ?? { enabled: true }
 
-  if (opts.labels || opts.prefix) {
+  if (opts.labels) {
     const labels = opts.labels ?? {}
-    if (opts.prefix) {
-      labels.prefix = opts.prefix
-    }
     register.setDefaultLabels(labels)
   }
 
   app.register(require('fastify-metrics'), {
     defaultMetrics: {
       ...defaultMetrics,
-      register
+      register,
     },
     endpoint: null,
     name: 'metrics',
     clearRegisterOnInit: false,
     promClient: {
       ...promClient,
-      register
+      register,
     },
     routeMetrics: {
       enabled: true,
       customLabels: {
         // TODO: check if this is set in prom
-        telemetry_id: (req) => req.headers['x-telemetry-id'] ?? 'unknown'
+        telemetry_id: (req) => req.headers['x-plt-telemetry-id'] ?? 'unknown',
       },
       overrides: {
         histogram: {
           name: 'http_request_duration_seconds',
-          registers: [register]
+          registers: [register],
         },
         summary: {
           name: 'http_request_summary_seconds',
-          registers: [register]
-        }
-      }
-    }
+          registers: [register],
+        },
+      },
+    },
   })
 
   app.register(fp(async (app) => {
@@ -59,7 +56,7 @@ const metricsPlugin = fp(async function (app, opts = {}) {
       collect: () => {
         process.nextTick(() => httpLatencyMetric.reset())
       },
-      registers: [register]
+      registers: [register],
     })
 
     const ignoredMethods = ['HEAD', 'OPTIONS', 'TRACE', 'CONNECT']
@@ -78,7 +75,7 @@ const metricsPlugin = fp(async function (app, opts = {}) {
       }
     })
   }, {
-    encapsulate: false
+    encapsulate: false,
   }))
 
   if (defaultMetrics.enabled) {
@@ -93,7 +90,7 @@ const metricsPlugin = fp(async function (app, opts = {}) {
           eluMetric.set(result)
           startELU = endELU
         },
-        registers: [register]
+        registers: [register],
       })
       app.metrics.client.register.registerMetric(eluMetric)
 
@@ -126,7 +123,7 @@ const metricsPlugin = fp(async function (app, opts = {}) {
           previousIdleTime = idleTime
           previousTotalTime = totalTime
         },
-        registers: [register]
+        registers: [register],
       })
       app.metrics.client.register.registerMetric(cpuMetric)
     })
@@ -142,20 +139,11 @@ const metricsPlugin = fp(async function (app, opts = {}) {
     }
   }
 
-  let isRestarting = false
-  app.addHook('onReady', async () => {
-    app.addPreRestartHook(async () => {
-      isRestarting = true
-      cleanMetrics()
-    })
-  })
   app.addHook('onClose', async () => {
-    if (!isRestarting) {
-      cleanMetrics()
-    }
+    cleanMetrics()
   })
 }, {
-  encapsulate: false
+  encapsulate: false,
 })
 
 // This is a global httpServer to match global
@@ -182,7 +170,7 @@ async function createMetricsServer (app, hostname, port) {
       httpServer.on('request', handler)
       return httpServer
     },
-    logger: app.log.child({ name: 'prometheus' })
+    loggerInstance: app.log.child({ name: 'prometheus' }),
   })
 
   app.addHook('onClose', async () => {
@@ -226,7 +214,7 @@ module.exports = fp(async function (app, opts) {
             return reply.code(401).send({ message: 'Unauthorized' })
           }
           return done()
-        }
+        },
       })
       onRequestHook = metricsServer.basicAuth
     }
@@ -246,7 +234,7 @@ module.exports = fp(async function (app, opts) {
         }
         reply.type('text/plain')
         return promRegistry.metrics()
-      }
+      },
     })
   }
 

package/lib/plugins/openapi.js

@@ -10,45 +10,34 @@ const fp = require('fastify-plugin')
 // despite being covered by test/routes.test.js
 /* c8 ignore next 33 */
 async function setupOpenAPI (app, opts) {
-  const { openapi, versions } = 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'
-    }
+      version: '1.0.0',
+    },
   }, 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}`
-      }
+      },
     },
-    transform: ({ schema, url }) => {
-      // Hide versioned endpoints
-      for (const version of versions?.configs ?? []) {
-        if (url.startsWith(version.openapi.prefix)) {
-          if (!schema) schema = {}
-          schema.hide = true
-          break
-        }
-      }
-      return { schema, url }
-    }
   }
 
   if (openapi.path) {
     swaggerOptions.mode = 'static'
     swaggerOptions.specification = {
-      path: openapi.path
+      path: openapi.path,
     }
   }
 
@@ -60,11 +49,11 @@ async function setupOpenAPI (app, opts) {
   /** Serve spec file in yaml and json */
   app.get(`${routePrefix}/json`, {
     schema: { hide: true },
-    logLevel: 'warn'
+    logLevel: 'warn',
   }, async () => app.swagger())
   app.get(`${routePrefix}/yaml`, {
     schema: { hide: true },
-    logLevel: 'warn'
+    logLevel: 'warn',
   }, async () => app.swagger({ yaml: true }))
 
   app.register(ScalarApiReference, {
@@ -72,8 +61,8 @@ async function setupOpenAPI (app, opts) {
     ...openapi,
     routePrefix,
     configuration: {
-      customCss: scalarTheme.theme
-    }
+      customCss: scalarTheme.theme,
+    },
   })
 }
 

package/lib/plugins/plugins.js

@@ -7,14 +7,14 @@ const wrapper = require('./sandbox-wrapper')
 
 const { getJSPluginPath, isFileAccessible } = require('../utils')
 
-async function loadPlugins (app) {
+async function loadPlugins (app, opts) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
 
   let isOutDirAccessible = false
   let outDir = null
 
-  const workingDir = configManager.dirname
+  const workingDir = opts?.context?.directory ?? configManager.dirname
   const tsConfigPath = configManager.current.plugins.typescript?.tsConfig || join(workingDir, 'tsconfig.json')
 
   // If the tsconfig.json file exists, then we need to adjust the plugin paths
@@ -34,12 +34,19 @@ async function loadPlugins (app) {
     isOutDirAccessible = await isFileAccessible(outDir)
   }
 
+  if (opts.context?.isProduction && !isOutDirAccessible) {
+    throw new Error(
+      `Cannot access directory '${outDir}'. Please run the 'build' command before running in production mode.`
+    )
+  }
+
   if (config.plugins.paths && isOutDirAccessible) {
-    config.plugins.paths = config.plugins.paths.map((plugin) => {
+    config.plugins.paths = config.plugins.paths.map(plugin => {
       /* c8 ignore next 3 */
-      const tmp = typeof plugin === 'string'
-        ? getJSPluginPath(workingDir, plugin, outDir)
-        : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
+      const tmp =
+        typeof plugin === 'string'
+          ? getJSPluginPath(workingDir, plugin, outDir)
+          : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
       return tmp
     })
   }

package/lib/plugins/sandbox-wrapper.js

@@ -36,7 +36,7 @@ module.exports = fp(async function (app, opts) {
         forceESM: plugin.forceESM,
         ignoreFilter: plugin.ignoreFilter,
         matchFilter: plugin.matchFilter,
-        ...patternOptions
+        ...patternOptions,
       })
     } else {
       let loaded = await import(pathToFileURL(plugin.path))
@@ -71,7 +71,7 @@ function patternOptionsFromPlugin (plugin) {
   const patternOptionKeys = [
     'ignorePattern',
     'indexPattern',
-    'autoHooksPattern'
+    'autoHooksPattern',
   ]
 
   for (const key of patternOptionKeys) {

package/lib/plugins/typescript.js

@@ -1,16 +1,20 @@
 'use strict'
 
 const fp = require('fastify-plugin')
-const compiler = require('../compile')
-
-async function setupTsCompiler (app) {
-  // TODO: move params to opts
+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 = configManager.dirname
+  const workingDir = opts?.context?.directory ?? configManager.dirname
 
-  await compiler.compile(workingDir, config, app.log, { clean: false })
+  await compiler.compile({
+    ...extractTypeScriptCompileOptionsFromConfig(config),
+    cwd: workingDir,
+    clean: false,
+    logger: app.log,
+  })
 }
 
 module.exports = fp(setupTsCompiler)

package/lib/root-endpoint/index.js

@@ -5,25 +5,8 @@ const fastifyStatic = require('@fastify/static')
 const userAgentParser = require('my-ua-parser')
 
 module.exports = async (app, opts) => {
-  const versions = opts.versions || {}
-
   app.register(fastifyStatic, {
-    root: path.join(__dirname, 'public')
-  })
-
-  app.route({
-    method: 'GET',
-    path: '/_platformatic_versions',
-    schema: { hide: true },
-    handler: () => {
-      const openapiUrls = []
-      for (const versionConfig of versions?.configs ?? []) {
-        const name = versionConfig.version
-        const prefix = versionConfig.openapi.prefix
-        openapiUrls.push({ name, prefix })
-      }
-      return openapiUrls
-    }
+    root: path.join(__dirname, 'public'),
   })
 
   // root endpoint
@@ -40,6 +23,6 @@ module.exports = async (app, opts) => {
         }
       }
       return { message: 'Welcome to Platformatic! Please visit https://docs.platformatic.dev' }
-    }
+    },
   })
 }

package/lib/root-endpoint/public/index.html

@@ -197,6 +197,7 @@
         <div class="button-container">
           <a href="https://docs.platformatic.dev" target="_blank" class="button-link">Documentation</a>
           <div class="open-documentation-version buttons-list-container">&nbsp;</div>
+          <a id="openapi-link" target="_blank" class="button-link">OpenAPI Documentation</a>
           <a id="graphql-link" target="_blank" class="button-link">GraphiQL</a>
         </div>
       </div>
@@ -205,6 +206,9 @@
     <script>
       const currentPath = window.location.pathname
     
+      const openApiLink = document.getElementById('openapi-link')
+      openApiLink.href = currentPath + 'documentation'
+
       const graphqlLink = document.getElementById('graphql-link')
       graphqlLink.href = currentPath + 'graphiql'
 
@@ -225,27 +229,6 @@
           document.getElementById('logo').src = 'images/platformatic-logo-dark.svg'
         }
       }
-
-      function join (...paths) {
-        return paths.join('/').replace(/\/+/g, '/')
-      }
-
-      fetch('/_platformatic_versions')
-        .then(response => response.json())
-        .then(versions => {
-          const sharedOpenapiHref = join(currentPath, 'documentation')
-          const openapiButtons = [
-            `<a href="${sharedOpenapiHref}"target="_blank" class="button-link">OpenAPI Documentation</a>`
-          ]
-
-          for (const version of versions) {
-            const href = join(currentPath, version.prefix, 'documentation')
-            openapiButtons.push(`<a href="${href}" target="_blank" class="button-link">OpenAPI Documentation ${version.name}</a>`)
-          }
-
-          const buttonList = document.getElementsByClassName('open-documentation-version')[0]
-          buttonList.innerHTML = openapiButtons.join('')
-        })
     </script>
   </body>
 </html>