@platformatic/service 0.11.0 → 0.12.1

package/help/help.txt

@@ -3,3 +3,4 @@ Available commands:
 * `help` - show this help message.
 * `help <command>` - shows more information about a command.
 * `start` - start the server.
+* `schema config` - generate the schema configuration file.

package/help/schema.txt

@@ -0,0 +1,9 @@
+Update the config schema file:
+
+* `schema config` - update the JSON schema config available on `platformatic.service.schema.json`
+
+Your configuration on `platformatic.service.json` has a schema defined to improve the developer experience and avoid mistakes when updating the configuration of Platformatic Service.
+When you run `platformatic service init`, a new JSON `$schema` property is added in `platformatic.service.json`. This can allow your IDE to add suggestions (f.e. mandatory/missing fields, types, default values) by opening the config in `platformatic.service.json`.
+Running `platformatic service schema config` you can update your schema so that it matches well the latest changes available on your config.
+
+

package/index.js

@@ -40,7 +40,6 @@ async function platformaticService (app, opts, toLoad = []) {
   {
     const fileWatcher = opts.fileWatcher
     const configManager = opts.configManager
-    /* c8 ignore next 4 */
     if (fileWatcher !== undefined) {
       app.platformatic.fileWatcher = fileWatcher
     }

package/lib/config.js

@@ -1,9 +1,8 @@
 'use strict'
 
 const ConfigManager = require('@platformatic/config')
-const { dirname, resolve, relative } = require('path')
+const { resolve } = require('path')
 const { schema } = require('./schema')
-const clone = require('rfdc')()
 
 class ServiceConfigManager extends ConfigManager {
   constructor (opts) {
@@ -41,33 +40,8 @@ class ServiceConfigManager extends ConfigManager {
     }
   }
 
-  _sanitizeConfig () {
-    const sanitizedConfig = clone(this.current)
-    const dirOfConfig = dirname(this.fullPath)
-
-    const fixPluginPath = (plugin) => {
-      // for some reasons c8 does not detect these
-      /* c8 ignore next 3 */
-      if (typeof plugin === 'string') {
-        plugin = { path: plugin }
-      }
-      plugin.path = relative(dirOfConfig, plugin.path)
-      return plugin
-    }
-
-    // relative-to-absolute plugin path
-    /* c8 ignore next 6 */
-    if (Array.isArray(this.current.plugin)) {
-      sanitizedConfig.plugin = sanitizedConfig.plugin.map(fixPluginPath)
-    } else if (this.current.plugin) {
-      sanitizedConfig.plugin = fixPluginPath(sanitizedConfig.plugin)
-    }
-
-    return sanitizedConfig
-  }
-
   _fixRelativePath (path) {
-    return resolve(dirname(this.fullPath), path)
+    return resolve(this.dirname, path)
   }
 }
 

package/lib/gen-schema.js

@@ -0,0 +1,14 @@
+
+const { writeFile } = require('fs/promises')
+const { schema: platformaticServiceSchema } = require('./schema.js')
+
+const filenameConfigJsonSchema = 'platformatic.service.schema.json'
+
+async function generateJsonSchemaConfig () {
+  await writeFile(filenameConfigJsonSchema, JSON.stringify(platformaticServiceSchema, null, 2))
+}
+
+module.exports = {
+  generateJsonSchemaConfig,
+  filenameConfigJsonSchema
+}

package/lib/metrics-plugin.js

@@ -87,7 +87,7 @@ module.exports = fp(async function (app, opts) {
   const metricsEndpointOptions = {
     url: '/metrics',
     method: 'GET',
-    logLevel: 'info',
+    logLevel: 'trace',
     handler: async (req, reply) => {
       const promRegistry = app.metrics.client.register
       const accepts = req.accepts()

package/lib/schema.js

@@ -96,7 +96,7 @@ const server = {
             enabled: { type: 'boolean' },
             interval: { type: 'integer' }
           },
-          additionalProperties: false
+          additionalProperties: true
         }
       ]
     },
@@ -134,7 +134,7 @@ const watch = {
 }
 
 const plugin = {
-  $id: 'https://schemas.platformatic.dev/service/plugin',
+  $id: '#plugin',
   type: 'object',
   properties: {
     path: {
@@ -148,6 +148,10 @@ const plugin = {
       properties: {
         outDir: {
           type: 'string'
+        },
+        build: {
+          type: 'boolean',
+          default: true
         }
       },
       additionalProperties: false,
@@ -177,13 +181,13 @@ const pluginTypes = {
     type: 'array',
     items: {
       anyOf: [{
-        $ref: '#/$defs/plugin'
+        $ref: '#plugin'
       }, {
         type: 'string'
       }]
     }
   }, {
-    $ref: '#/$defs/plugin'
+    $ref: '#plugin'
   }, {
     type: 'string'
   }]

package/lib/start.mjs

@@ -19,13 +19,17 @@ async function start (_args) {
 
   if (
     config.plugin?.typescript !== undefined &&
-    config.plugin?.watch !== false
+    config.plugin?.watch !== false &&
+    config.plugin?.typescript?.build !== false
   ) {
     try {
       await compileWatch()
     } catch (error) {
       process.exit(1)
     }
+  } else if (config.plugin?.typescript !== undefined && config.plugin?.typescript?.build === false) {
+    // we don't have the logger here, shall we create one just for this message?
+    console.log(`TS build is disabled, expecting compiled js files in ${config.plugin.typescript.outDir} folder`)
   }
 
   // Set the location of the config

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "description": "",
   "main": "index.js",
   "author": "Matteo Collina <hello@matteocollina.com>",
@@ -14,47 +14,49 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "devDependencies": {
-    "c8": "^7.11.0",
+    "bindings": "^1.5.0",
+    "c8": "^7.12.0",
     "snazzy": "^9.0.0",
     "split2": "^4.1.0",
     "standard": "^17.0.0",
     "strip-ansi": "^7.0.1",
-    "tap": "^16.0.0",
-    "typescript": "^4.8.4",
-    "undici": "^5.8.0",
+    "tap": "^16.3.2",
+    "typescript": "^4.9.4",
+    "undici": "^5.14.0",
+    "vscode-json-languageservice": "^5.1.3",
     "why-is-node-running": "^2.2.2",
-    "yaml": "^2.1.1"
+    "yaml": "^2.1.3"
   },
   "dependencies": {
-    "@fastify/accepts": "^4.0.1",
-    "@fastify/autoload": "^5.5.0",
+    "@fastify/accepts": "^4.1.0",
+    "@fastify/autoload": "^5.6.0",
     "@fastify/basic-auth": "^5.0.0",
-    "@fastify/cors": "^8.0.0",
-    "@fastify/deepmerge": "^1.1.0",
-    "@fastify/restartable": "^1.3.1",
-    "@fastify/static": "^6.5.0",
-    "@fastify/swagger": "^8.0.0",
-    "@fastify/under-pressure": "^8.0.0",
+    "@fastify/cors": "^8.2.0",
+    "@fastify/deepmerge": "^1.3.0",
+    "@fastify/restartable": "^1.4.0",
+    "@fastify/static": "^6.6.0",
+    "@fastify/swagger": "^8.2.1",
+    "@fastify/under-pressure": "^8.2.0",
     "close-with-grace": "^1.1.0",
-    "commist": "^3.1.2",
-    "desm": "^1.2.0",
-    "env-schema": "^5.0.0",
+    "commist": "^3.2.0",
+    "desm": "^1.3.0",
+    "env-schema": "^5.2.0",
     "es-main": "^1.2.0",
     "execa": "^6.1.0",
-    "fastify": "^4.6.0",
+    "fastify": "^4.10.2",
     "fastify-metrics": "^10.0.0",
-    "fastify-plugin": "^4.1.0",
+    "fastify-plugin": "^4.4.0",
     "fastify-sandbox": "^0.11.0",
     "graphql": "^16.6.0",
-    "help-me": "^4.1.0",
-    "mercurius": "^11.3.0",
-    "minimatch": "^5.1.0",
-    "minimist": "^1.2.6",
-    "pino": "^8.4.1",
-    "pino-pretty": "^9.0.0",
+    "help-me": "^4.2.0",
+    "mercurius": "^11.4.0",
+    "minimatch": "^5.1.1",
+    "minimist": "^1.2.7",
+    "pino": "^8.8.0",
+    "pino-pretty": "^9.1.1",
     "rfdc": "^1.3.0",
-    "@platformatic/config": "0.11.0",
-    "@platformatic/utils": "0.11.0"
+    "@platformatic/config": "0.12.1",
+    "@platformatic/utils": "0.12.1"
   },
   "standard": {
     "ignore": [

package/service.mjs

@@ -6,6 +6,7 @@ import isMain from 'es-main'
 import helpMe from 'help-me'
 import { readFile } from 'fs/promises'
 import { join } from 'desm'
+import { generateJsonSchemaConfig } from './lib/gen-schema.js'
 
 import start from './lib/start.mjs'
 import { compile } from './lib/compile.js'
@@ -16,13 +17,15 @@ const help = helpMe({
   ext: '.txt'
 })
 
-const program = commist({ maxDistance: 4 })
+const program = commist({ maxDistance: 2 })
 
 program.register('help', help.toStdout)
 program.register('help start', help.toStdout.bind(null, ['start']))
 
 program.register('start', start)
 program.register('compile', compile)
+program.register('schema config', generateJsonSchemaConfig)
+program.register('schema', help.toStdout.bind(null, ['schema']))
 
 export async function runService (argv) {
   const args = parseArgs(argv, {
@@ -36,11 +39,9 @@ export async function runService (argv) {
     process.exit(0)
   }
 
-  const result = program.parse(argv)
-
-  if (result) {
-    // We did have a command we did not match
-    return start(result)
+  return {
+    output: await program.parseAsync(argv),
+    help
   }
 }
 

package/test/cli/compile.test.mjs

@@ -37,6 +37,31 @@ t.test('should compile typescript plugin', async (t) => {
   t.pass()
 })
 
+t.test('should compile typescript plugin even if build is `false`', async (t) => {
+  const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin-nocompile')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-2')
+
+  await cp(testDir, cwd, { recursive: true })
+
+  try {
+    const child = await execa('node', [cliPath, 'compile'], { cwd })
+    t.equal(child.stdout.includes('Typescript compilation completed successfully.'), true)
+  } catch (err) {
+    console.log(err.stdout)
+    console.log(err.stderr)
+    t.fail(err.stderr)
+  }
+
+  const jsPluginPath = path.join(cwd, 'dist', 'plugin.js')
+  try {
+    await access(jsPluginPath)
+  } catch (err) {
+    t.fail(err)
+  }
+
+  t.pass()
+})
+
 t.test('should compile typescript plugin with start command', async (t) => {
   const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin')
   const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-3')
@@ -91,7 +116,7 @@ t.test('should not compile bad typescript plugin', async (t) => {
 
 t.test('missing tsconfig file', async (t) => {
   const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin')
-  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-2')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-4')
 
   await cp(testDir, cwd, { recursive: true })
 
@@ -138,7 +163,7 @@ t.test('start command should not compile typescript plugin with errors', async (
 
 t.test('should not compile typescript plugin with start without tsconfig', async (t) => {
   const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin')
-  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-4')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-5')
 
   await cp(testDir, cwd, { recursive: true })
 
@@ -155,3 +180,34 @@ t.test('should not compile typescript plugin with start without tsconfig', async
     t.equal(err.stdout.includes('The tsconfig.json file was not found.'), true)
   }
 })
+
+t.test('start command should not compile typescript if `build` is false', async (t) => {
+  const testDir = path.join(urlDirname(import.meta.url), '..', 'fixtures', 'typescript-plugin-nocompile')
+  const cwd = path.join(urlDirname(import.meta.url), '..', 'tmp', 'typescript-plugin-clone-6')
+
+  await cp(testDir, cwd, { recursive: true })
+
+  const child = execa('node', [cliPath, 'start'], { cwd })
+  t.teardown(async () => {
+    if (os.platform() === 'win32') {
+      try {
+        await execa('taskkill', ['/pid', child.pid, '/f', '/t'])
+      } catch (err) {
+        console.error(`Failed to kill process ${child.pid})`)
+      }
+    } else {
+      child.kill('SIGINT')
+    }
+  })
+
+  const jsPluginPath = path.join(cwd, 'dist', 'plugin.js')
+  try {
+    await access(jsPluginPath)
+    t.fail("should not have created 'dist/plugin.js'")
+  } catch (err) {
+    // cannot start because the plugin is not compiled
+    t.equal(err.code, 'ENOENT')
+    t.equal(err.path, jsPluginPath)
+    t.pass()
+  }
+})

package/test/cli/gen-schema.test.mjs

@@ -0,0 +1,43 @@
+import { test } from 'tap'
+import fs from 'fs/promises'
+import { mkdtempSync } from 'fs'
+import { tmpdir } from 'os'
+import { generateJsonSchemaConfig } from '../../lib/gen-schema.js'
+import { join } from 'path'
+import jsonLanguageService from 'vscode-json-languageservice'
+
+test('generateJsonSchemaConfig generates the file', async (t) => {
+  const tmpDir = await mkdtempSync(join(tmpdir(), 'test-create-platformatic-'))
+  process.chdir(tmpDir)
+  await generateJsonSchemaConfig()
+
+  const configSchema = await fs.readFile('platformatic.service.schema.json', 'utf8')
+  const schema = JSON.parse(configSchema)
+  const { required, additionalProperties } = schema
+  t.has(required, ['server'])
+  t.has(additionalProperties, { watch: {} })
+  const { $id, type } = schema
+  t.equal($id, 'https://schemas.platformatic.dev/service')
+  t.equal(type, 'object')
+
+  const languageservice = jsonLanguageService.getLanguageService({
+    async schemaRequestService (uri) {
+      return configSchema
+    }
+  })
+
+  languageservice.configure({ allowComments: false, schemas: [{ fileMatch: ['*.data.json'], uri: $id }] })
+
+  const jsonContent = `{
+    "$schema": "https://schemas.platformatic.dev/service",
+    "server": {
+      "hostname": "127.0.0.1",
+      "port": 3000
+    }
+  }`
+  const jsonContentUri = 'foo://server/example.data.json'
+  const textDocument = jsonLanguageService.TextDocument.create(jsonContentUri, 'json', 1, jsonContent)
+  const jsonDocument = languageservice.parseJSONDocument(textDocument)
+  const diagnostics = await languageservice.doValidation(textDocument, jsonDocument)
+  t.equal(diagnostics.length, 0)
+})

package/test/cli/helper.mjs

@@ -23,7 +23,7 @@ setGlobalDispatcher(new Agent({
 export const cliPath = join(import.meta.url, '..', '..', 'service.mjs')
 
 export async function start (...args) {
-  const child = execa('node', [cliPath, ...args])
+  const child = execa('node', [cliPath, 'start', ...args])
   child.stderr.pipe(process.stdout)
 
   const output = child.stdout.pipe(split(function (line) {

package/test/cli/validations.test.mjs

@@ -12,13 +12,13 @@ test('version', async (t) => {
 })
 
 test('missing config', async (t) => {
-  await t.rejects(execa('node', [cliPath]))
+  await t.rejects(execa('node', [cliPath, 'start']))
 })
 
 test('print validation errors', async ({ equal, plan }) => {
   plan(2)
   try {
-    await execa('node', [cliPath, '--config', join(import.meta.url, '..', 'fixtures', 'missing-property.config.json')])
+    await execa('node', [cliPath, 'start', '--config', join(import.meta.url, '..', 'fixtures', 'missing-property.config.json')])
   } catch (err) {
     equal(err.exitCode, 1)
     equal(err.stdout, `

package/test/cli/watch.test.mjs

@@ -136,7 +136,7 @@ test('should not watch ignored file', async ({ teardown, equal }) => {
   equal(version, 'v1')
 })
 
-test('should not loop forever when doing ESM', { skip: true }, async ({ comment, fail }) => {
+test('should not loop forever when doing ESM', async ({ comment, fail }) => {
   const tmpDir = await mkdtemp(join(os.tmpdir(), 'watch-esm-'))
   const pluginFilePath = join(tmpDir, 'plugin.mjs')
   const configFilePath = join(tmpDir, 'platformatic.service.json')

package/test/fixtures/typescript-plugin-nocompile/platformatic.service.json

@@ -0,0 +1,16 @@
+{
+  "server": {
+    "logger": {
+      "level": "info"
+    },
+    "hostname": "127.0.0.1",
+    "port": "0"
+  },
+  "plugin": {
+    "path": "plugin.ts",
+    "typescript": {
+      "outDir": "dist",
+      "build": false
+    }
+  }
+}

package/test/fixtures/typescript-plugin-nocompile/plugin.ts

@@ -0,0 +1,5 @@
+import { FastifyInstance } from 'fastify'
+
+export default async function (app: FastifyInstance) {
+  app.log.info('Typescript plugin loaded')
+}

package/test/fixtures/typescript-plugin-nocompile/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "esModuleInterop": true,
+    "target": "es6",
+    "moduleResolution": "node",
+    "sourceMap": true,
+    "pretty": true,
+    "noEmitOnError": true,
+    "outDir": "dist"
+  },
+  "watchOptions": {
+    "watchFile": "fixedPollingInterval",
+    "watchDirectory": "fixedPollingInterval",
+    "fallbackPolling": "dynamicPriority",
+    "synchronousWatchDirectory": true,
+    "excludeDirectories": [
+      "**/node_modules",
+      "dist"
+    ]
+  }
+}

package/test/load-and-reload-files.test.js

@@ -201,7 +201,7 @@ test('load and reload with the fallback', async ({ teardown, equal, pass, same }
   }
 })
 
-test('load and reload ESM', { skip: true }, async ({ teardown, equal, pass, same }) => {
+test('load and reload ESM', async ({ teardown, equal, pass, same }) => {
   const file = join(os.tmpdir(), `some-plugin-${process.pid}.mjs`)
 
   await writeFile(file, `

package/test/tmp/platformatic.service.schema.json

@@ -0,0 +1,263 @@
+{
+  "$id": "https://schemas.platformatic.dev/service",
+  "type": "object",
+  "properties": {
+    "server": {
+      "$id": "https://schemas.platformatic.dev/service/server",
+      "type": "object",
+      "properties": {
+        "hostname": {
+          "type": "string"
+        },
+        "port": {
+          "anyOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "string"
+            }
+          ]
+        },
+        "pluginTimeout": {
+          "type": "integer"
+        },
+        "healthCheck": {
+          "anyOf": [
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "enabled": {
+                  "type": "boolean"
+                },
+                "interval": {
+                  "type": "integer"
+                }
+              },
+              "additionalProperties": true
+            }
+          ]
+        },
+        "cors": {
+          "type": "object",
+          "$comment": "See https://github.com/fastify/fastify-cors",
+          "properties": {
+            "origin": {
+              "anyOf": [
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              ]
+            },
+            "methods": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "allowedHeaders": {
+              "type": "string",
+              "description": "Comma separated string of allowed headers."
+            },
+            "exposedHeaders": {
+              "anyOf": [
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                },
+                {
+                  "type": "string",
+                  "description": "Comma separated string of exposed headers."
+                }
+              ]
+            },
+            "credentials": {
+              "type": "boolean"
+            },
+            "maxAge": {
+              "type": "integer"
+            },
+            "preflightContinue": {
+              "type": "boolean",
+              "default": false
+            },
+            "optionsSuccessStatus": {
+              "type": "integer",
+              "default": 204
+            },
+            "preflight": {
+              "type": "boolean",
+              "default": true
+            },
+            "strictPreflight": {
+              "type": "boolean",
+              "default": true
+            },
+            "hideOptionsRoute": {
+              "type": "boolean",
+              "default": true
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "hostname",
+        "port"
+      ]
+    },
+    "plugin": {
+      "$id": "https://schemas.platformatic.dev/service/pluginTypes",
+      "$defs": {
+        "plugin": {
+          "$id": "#plugin",
+          "type": "object",
+          "properties": {
+            "path": {
+              "type": "string"
+            },
+            "stopTimeout": {
+              "type": "integer"
+            },
+            "typescript": {
+              "type": "object",
+              "properties": {
+                "outDir": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "outDir"
+              ]
+            },
+            "fallback": {
+              "type": "boolean"
+            },
+            "hotReload": {
+              "type": "boolean",
+              "default": true
+            },
+            "options": {
+              "type": "object"
+            }
+          },
+          "additionalProperties": false,
+          "required": [
+            "path"
+          ]
+        }
+      },
+      "anyOf": [
+        {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "$ref": "#plugin"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          }
+        },
+        {
+          "$ref": "#plugin"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "metrics": {
+      "$id": "https://schemas.platformatic.dev/service/metrics",
+      "anyOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "port": {
+              "type": "integer"
+            },
+            "hostname": {
+              "type": "string"
+            },
+            "auth": {
+              "type": "object",
+              "properties": {
+                "username": {
+                  "type": "string"
+                },
+                "password": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false,
+              "required": [
+                "username",
+                "password"
+              ]
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    }
+  },
+  "additionalProperties": {
+    "watch": {
+      "anyOf": [
+        {
+          "$id": "https://schemas.platformatic.dev/service/watch",
+          "type": "object",
+          "properties": {
+            "type": "object",
+            "properties": {
+              "allow": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "minItems": 1,
+                "nullable": true,
+                "default": null
+              },
+              "ignore": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "nullable": true,
+                "default": null
+              }
+            },
+            "additionalProperties": false
+          }
+        },
+        {
+          "type": "boolean"
+        }
+      ]
+    }
+  },
+  "required": [
+    "server"
+  ]
+}