@platformatic/service 1.10.0 → 1.12.0

package/help/compile.txt

@@ -7,6 +7,8 @@ Compile typescript plugins.
 As a result of executing this command, Platformatic Service will compile typescript
 plugins in the `outDir` directory. 
 
+Using the  `--clean` flag, the outDir directory will be removed before the new compilation process starts.
+
 If not specified, the configuration will be loaded from any of the following, in the current directory.
 
 * `platformatic.service.json`, or

package/index.d.ts

@@ -38,8 +38,11 @@ interface SchemaExport {
   schema: JSONSchemaType<PlatformaticServiceConfig>
 }
 
+interface TSCompilerOptions {
+  clean: boolean
+}
 interface TSCompiler {
-  compile: (cwd: string, config: object, originalLogger: FastifyBaseLogger) => Promise<boolean>
+  compile: (cwd: string, config: object, originalLogger: FastifyBaseLogger, options: TSCompilerOptions) => Promise<boolean>
 }
 export const schema: SchemaExport
 

package/lib/compile.js

@@ -5,6 +5,7 @@ const pino = require('pino')
 const pretty = require('pino-pretty')
 const { loadConfig } = require('@platformatic/config')
 const { isFileAccessible } = require('./utils.js')
+const { readFile, rm } = require('fs/promises')
 
 async function getTSCExecutablePath (cwd) {
   const typescriptPath = require.resolve('typescript')
@@ -62,7 +63,7 @@ async function setup (cwd, config, logger) {
   return { execa, logger, tscExecutablePath, tsConfigPath, tsConfigExists }
 }
 
-async function compile (cwd, config, originalLogger) {
+async function compile (cwd, config, originalLogger, options) {
   const { execa, logger, tscExecutablePath, tsConfigPath, tsConfigExists } = await setup(cwd, config, originalLogger)
   /* c8 ignore next 3 */
   if (!tscExecutablePath || !tsConfigExists) {
@@ -75,7 +76,18 @@ async function compile (cwd, config, originalLogger) {
       ...process.env
     }
     delete env.NODE_V8_COVERAGE
-
+    // somehow c8 does not pick up these lines even if there is a specific test
+    /* c8 ignore 10 */
+    if (options.clean) {
+      // delete outdir directory
+      const tsConfigContents = JSON.parse(await readFile(tsConfigPath, 'utf8'))
+      const outDir = tsConfigContents.compilerOptions.outDir
+      if (outDir) {
+        const outDirFullPath = join(dirname(tsConfigPath), outDir)
+        originalLogger.info(`Removing build directory ${outDirFullPath}`)
+        await rm(outDirFullPath, { recursive: true })
+      }
+    }
     await execa(tscExecutablePath, tsFlags, { cwd, env })
     logger.info('Typescript compilation completed successfully.')
     return true
@@ -101,8 +113,17 @@ function buildCompileCmd (app) {
       console.error(err)
       process.exit(1)
     }
+    const compileOptions = {
+      clean: _args.includes('--clean')
+    }
+    const logger = pino(
+      pretty({
+        translateTime: 'SYS:HH:MM:ss',
+        ignore: 'hostname,pid'
+      })
+    )
 
-    if (!await compile(fullPath, config)) {
+    if (!await compile(fullPath, config, logger, compileOptions)) {
       process.exit(1)
     }
   }

package/lib/gen-types.mjs

@@ -28,8 +28,6 @@ async function generateTypes (_args) {
     ignore: 'hostname,pid'
   }))
   const { configManager, args } = await loadConfig({}, _args, platformaticService)
-
-  console.log('antanis', new Error().stack)
   await configManager.parseAndValidate()
   const config = configManager.current
 

package/lib/plugins/openapi.js

@@ -19,7 +19,7 @@ async function setupOpenAPI (app, opts) {
     }
   }, typeof opts === 'object' ? opts : {})
   app.log.trace({ openapi: openapiConfig })
-  await app.register(Swagger, {
+  const swaggerOptions = {
     exposeRoute: openapiConfig.exposeRoute,
     openapi: {
       ...openapiConfig
@@ -31,7 +31,15 @@ async function setupOpenAPI (app, opts) {
         return json.$id || `def-${i}`
       }
     }
-  })
+  }
+
+  if (opts.path) {
+    swaggerOptions.mode = 'static'
+    swaggerOptions.specification = {
+      path: opts.path
+    }
+  }
+  await app.register(Swagger, swaggerOptions)
 
   const { default: theme } = await import('@platformatic/swagger-ui-theme')
   app.register(SwaggerUI, {

package/lib/plugins/plugins.js

@@ -3,11 +3,10 @@
 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')
 
-const wrapperPath = join(__dirname, 'sandbox-wrapper.js')
-
 async function loadPlugins (app) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
@@ -45,7 +44,7 @@ async function loadPlugins (app) {
     })
   }
 
-  await app.register(require(wrapperPath), { paths: config.plugins.paths })
+  await app.register(wrapper, { packages: config.plugins.packages, paths: config.plugins.paths })
 }
 
 module.exports = fp(loadPlugins)

package/lib/plugins/sandbox-wrapper.js

@@ -2,14 +2,26 @@
 
 const fp = require('fastify-plugin')
 const autoload = require('@fastify/autoload')
-const { stat } = require('fs').promises
+const { stat } = require('node:fs').promises
+const { createRequire } = require('node:module')
+const { join } = require('node:path')
+const { pathToFileURL } = require('node:url')
 
 module.exports = fp(async function (app, opts) {
-  for (let plugin of opts.paths) {
+  // fake require next to the configManager dirname
+  const _require = createRequire(join(app.platformatic.configManager.dirname, 'package.json'))
+  for (const plugin of opts.packages || []) {
+    const name = typeof plugin === 'string' ? plugin : plugin.name
+    const url = pathToFileURL(_require.resolve(name))
+    const loaded = await import(url)
+    await app.register(loaded, plugin.options)
+  }
+
+  for (let plugin of opts.paths || []) {
     if (typeof plugin === 'string') {
       plugin = { path: plugin, encapsulate: true }
     }
-    if ((await stat(plugin.path)).isDirectory()) {
+    if (plugin.path && (await stat(plugin.path)).isDirectory()) {
       const patternOptions = patternOptionsFromPlugin(plugin)
 
       app.register(autoload, {
@@ -27,7 +39,7 @@ module.exports = fp(async function (app, opts) {
         ...patternOptions
       })
     } else {
-      let loaded = await import(`file://${plugin.path}`)
+      let loaded = await import(pathToFileURL(plugin.path))
       /* c8 ignore next 3 */
       if (loaded.__esModule === true || typeof loaded.default === 'function') {
         loaded = loaded.default
@@ -56,7 +68,11 @@ function patternOptionsFromPlugin (plugin) {
   const config = {}
 
   // Expected keys for autoload plugin options that expect regexp patterns
-  const patternOptionKeys = ['ignorePattern', 'indexPattern', 'autoHooksPattern']
+  const patternOptionKeys = [
+    'ignorePattern',
+    'indexPattern',
+    'autoHooksPattern'
+  ]
 
   for (const key of patternOptionKeys) {
     const pattern = plugin[key]

package/lib/plugins/typescript.js

@@ -10,7 +10,7 @@ async function setupTsCompiler (app) {
   const config = configManager.current
   const workingDir = configManager.dirname
 
-  await compiler.compile(workingDir, config, app.log)
+  await compiler.compile(workingDir, config, app.log, { clean: false })
 }
 
 module.exports = fp(setupTsCompiler)

package/lib/schema.js

@@ -422,6 +422,26 @@ const plugins = {
   $id: '#plugins',
   type: 'object',
   properties: {
+    packages: {
+      type: 'array',
+      items: {
+        anyOf: [{
+          type: 'string'
+        }, {
+          type: 'object',
+          properties: {
+            name: {
+              type: 'string'
+            },
+            options: {
+              type: 'object',
+              additionalProperties: true
+            }
+          },
+          required: ['name']
+        }]
+      }
+    },
     paths: {
       type: 'array',
       items: {
@@ -517,7 +537,11 @@ const plugins = {
     }
   },
   additionalProperties: false,
-  required: ['paths']
+  anyOf: [{
+    required: ['paths']
+  }, {
+    required: ['packages']
+  }]
 }
 
 const metrics = {
@@ -600,6 +624,11 @@ const openApiBase = {
     prefix: {
       type: 'string',
       description: 'Base URL for the OpenAPI'
+    },
+    path: {
+      type: 'string',
+      description: 'Path to an OpenAPI spec file',
+      resolvePath: true
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "1.10.0",
+  "version": "1.12.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -18,6 +18,7 @@
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
     "@fastify/aws-lambda": "^3.3.0",
+    "@fastify/compress": "^6.5.0",
     "bindings": "^1.5.0",
     "c8": "^8.0.1",
     "glob": "^10.3.10",
@@ -68,11 +69,11 @@
     "pino-pretty": "^10.2.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.36",
-    "@platformatic/client": "1.10.0",
-    "@platformatic/swagger-ui-theme": "1.10.0",
-    "@platformatic/telemetry": "1.10.0",
-    "@platformatic/config": "1.10.0",
-    "@platformatic/utils": "1.10.0"
+    "@platformatic/client": "1.12.0",
+    "@platformatic/config": "1.12.0",
+    "@platformatic/swagger-ui-theme": "1.12.0",
+    "@platformatic/telemetry": "1.12.0",
+    "@platformatic/utils": "1.12.0"
   },
   "standard": {
     "ignore": [