@platformatic/service 0.20.0 → 0.21.0

package/.taprc

@@ -1,2 +1,2 @@
-timeout: 160
-coverage: false
+timeout: 500
+coverage: false

package/fixtures/hello/platformatic.service.json

@@ -3,14 +3,17 @@
     "hostname": "127.0.0.1",
     "port": 0,
     "logger": {
-      "level": "info"
+      "level": "info",
+      "name": "hello server"
     }
   },
   "plugins": {
-    "paths": ["./plugin.js"]
+    "paths": ["./plugin.js"],
+    "hotReload": false
   },
   "service": {
     "openapi": true
   },
-  "metrics": false
+  "metrics": false,
+  "watch": false
 }

package/fixtures/hello-client/platformatic.service.json

@@ -3,15 +3,18 @@
     "hostname": "127.0.0.1",
     "port": 0,
     "logger": {
-      "level": "info"
+      "level": "info",
+      "name": "hello client"
     }
   },
   "plugins": {
-    "paths": ["./plugin.js"]
+    "paths": ["./plugin.js"],
+    "hotReload": false
   },
   "clients": [{
     "path": "./hello",
     "url": "{PLT_CLIENT_URL}"
   }],
-  "metrics": false
+  "metrics": false,
+  "watch": false
 }

package/fixtures/hello-client-ts/platformatic.service.json

@@ -3,16 +3,19 @@
     "hostname": "127.0.0.1",
     "port": 0,
     "logger": {
-      "level": "info"
+      "level": "info",
+      "name": "hello client ts"
     }
   },
   "plugins": {
     "paths": ["./plugin.ts"],
-    "typescript": true
+    "typescript": true,
+    "hotReload": false
   },
   "clients": [{
     "path": "./hello",
     "url": "{PLT_CLIENT_URL}"
   }],
-  "metrics": false
+  "metrics": false,
+  "watch": false
 }

package/index.js

@@ -4,9 +4,9 @@ const { start } = require('@fastify/restartable')
 const sandbox = require('fastify-sandbox')
 const underPressure = require('@fastify/under-pressure')
 const { schema } = require('./lib/schema')
-const ConfigManager = require('./lib/config.js')
+const ConfigManager = require('@platformatic/config')
+const { loadConfig, generateDefaultConfig } = require('./lib/load-config')
 const { addLoggerToTheConfig, getJSPluginPath, isFileAccessible } = require('./lib/utils')
-const loadConfig = require('./lib/load-config')
 const { isKeyEnabled, deepmerge } = require('@platformatic/utils')
 const compiler = require('./lib/compile')
 const { join, dirname, resolve } = require('path')
@@ -58,6 +58,9 @@ async function platformaticService (app, opts, toLoad = []) {
     if (configManager !== undefined) {
       app.platformatic.configManager = configManager
       app.platformatic.config = configManager.current
+      /* c8 ignore next 3 */
+    } else {
+      throw new Error('configManager is required')
     }
   }
 
@@ -167,6 +170,7 @@ async function platformaticService (app, opts, toLoad = []) {
 
 platformaticService[Symbol.for('skip-override')] = true
 platformaticService.schema = schema
+platformaticService.envWhitelist = ['PORT', 'HOSTNAME']
 
 function adjustConfigBeforeMerge (cm) {
   // This function and adjustConfigAfterMerge() are needed because there are
@@ -217,16 +221,27 @@ async function adjustHttpsKeyAndCert (arg) {
   return arg
 }
 
-async function buildServer (options, app, ConfigManagerContructor) {
+function defaultConfig (app, source) {
+  const res = {
+    source,
+    ...generateDefaultConfig(),
+    allowToWatch: ['.env', ...(app?.allowToWatch || [])],
+    envWhitelist: ['PORT', ...(app?.envWhitelist || [])]
+  }
+
+  if (app.schema) {
+    res.schema = app.schema
+  }
+
+  return res
+}
+
+async function buildServer (options, app) {
   app = app || platformaticService
-  ConfigManagerContructor = ConfigManagerContructor || ConfigManager
 
   if (!options.configManager) {
     // instantiate a new config manager from current options
-    const cm = new ConfigManagerContructor({
-      source: options,
-      schema: app?.schema ?? schema
-    })
+    const cm = new ConfigManager(defaultConfig(app, options))
     await cm.parseAndValidate()
     const stash = adjustConfigBeforeMerge(cm.current)
     options = deepmerge({}, options, cm.current)
@@ -310,6 +325,6 @@ module.exports.createServerConfig = createServerConfig
 module.exports.platformaticService = platformaticService
 module.exports.addLoggerToTheConfig = addLoggerToTheConfig
 module.exports.loadConfig = loadConfig
+module.exports.generateConfigManagerConfig = generateDefaultConfig
 module.exports.tsCompiler = compiler
-module.exports.ConfigManager = ConfigManager
 module.exports.buildStart = buildStart

package/lib/compile.js

@@ -3,7 +3,7 @@
 const { resolve, join, dirname } = require('path')
 const pino = require('pino')
 const pretty = require('pino-pretty')
-const loadConfig = require('./load-config.js')
+const { loadConfig } = require('./load-config.js')
 const { isFileAccessible } = require('./utils.js')
 
 async function getTSCExecutablePath (cwd) {

package/lib/load-config.js

@@ -2,9 +2,10 @@
 
 const parseArgs = require('minimist')
 const { access } = require('fs/promises')
-const ConfigManager = require('./config.js')
+const ConfigManager = require('@platformatic/config')
 const deepmerge = require('@fastify/deepmerge')
 const { findConfigFile } = require('./utils.js')
+const { schema } = require('./schema.js')
 
 const ourConfigFiles = [
   'platformatic.service.json',
@@ -15,7 +16,22 @@ const ourConfigFiles = [
   'platformatic.service.tml'
 ]
 
-async function loadConfig (minimistConfig, _args, configOpts = {}, Manager = ConfigManager, configFileNames = ourConfigFiles) {
+function generateDefaultConfig () {
+  return {
+    schema,
+    schemaOptions: {
+      useDefaults: true,
+      coerceTypes: true,
+      allErrors: true,
+      strict: false
+    }
+  }
+}
+
+// Unfortunately c8 does not see those on Windows
+/* c8 ignore next 70 */
+async function loadConfig (minimistConfig, _args, defaultConfig, configFileNames = ourConfigFiles) {
+  defaultConfig ??= generateDefaultConfig()
   const args = parseArgs(_args, deepmerge({ all: true })({
     string: ['allow-env'],
     boolean: ['hotReload'],
@@ -46,10 +62,9 @@ Error: ${err}
     process.exit(1)
   }
 
-  const configManager = new Manager({
+  const configManager = new ConfigManager({
     source: args.config,
-    envWhitelist: [...args.allowEnv.split(',')],
-    ...configOpts
+    ...defaultConfig
   })
 
   const parsingResult = await configManager.parse()
@@ -71,4 +86,5 @@ function printConfigValidationErrors (configManager) {
   console.table(tabularData, ['path', 'message'])
 }
 
-module.exports = loadConfig
+module.exports.loadConfig = loadConfig
+module.exports.generateDefaultConfig = generateDefaultConfig

package/lib/start.mjs

@@ -2,7 +2,7 @@ import { dirname } from 'path'
 import { FileWatcher } from '@platformatic/utils'
 import { buildServer } from '../index.js'
 import close from 'close-with-grace'
-import loadConfig from './load-config.js'
+import { loadConfig, generateDefaultConfig } from './load-config.js'
 import { compileWatch } from './compile.js'
 import { addLoggerToTheConfig } from './utils.js'
 
@@ -10,9 +10,18 @@ import { addLoggerToTheConfig } from './utils.js'
 // Currently C8 is not reporting it
 /* c8 ignore start */
 
+function defaultConfig () {
+  const _defaultConfig = generateDefaultConfig()
+  return {
+    watch: true,
+    ..._defaultConfig
+  }
+}
+
 export function buildStart (_loadConfig, _buildServer) {
   return async function start (_args) {
-    const { configManager, args } = await _loadConfig({}, _args, { watch: true })
+    const _defaultConfig = defaultConfig()
+    const { configManager, args } = await _loadConfig({}, _args, _defaultConfig)
 
     const config = configManager.current
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -26,8 +26,8 @@
     "standard": "^17.0.0",
     "strip-ansi": "^7.0.1",
     "tap": "^16.3.4",
-    "typescript": "^5.0.0",
     "tsd": "^0.28.0",
+    "typescript": "^5.0.0",
     "undici": "^5.20.0",
     "vscode-json-languageservice": "^5.3.0",
     "why-is-node-running": "^2.2.2",
@@ -63,9 +63,9 @@
     "pino-pretty": "^10.0.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.33",
-    "@platformatic/config": "0.20.0",
-    "@platformatic/utils": "0.20.0",
-    "@platformatic/client": "0.20.0"
+    "@platformatic/client": "0.21.0",
+    "@platformatic/config": "0.21.0",
+    "@platformatic/utils": "0.21.0"
   },
   "standard": {
     "ignore": [

package/service.mjs

@@ -34,6 +34,7 @@ export async function runService (argv) {
     }
   })
 
+  /* c8 ignore next 4 */
   if (args.version) {
     console.log('v' + JSON.parse(await readFile(join(import.meta.url, 'package.json'))).version)
     process.exit(0)

package/test/autoload.test.js

@@ -361,7 +361,9 @@ test('nested directories', async ({ teardown, equal, same }) => {
   const config = {
     server: {
       hostname: '127.0.0.1',
-      port: 0
+      port: 0,
+      // Windows CI is slow
+      pluginTimeout: 60 * 1000
     },
     service: {
       openapi: true

package/test/cli/helper.mjs

@@ -1,16 +1,9 @@
-import why from 'why-is-node-running'
 import { Agent, setGlobalDispatcher } from 'undici'
 import { on } from 'events'
 import { execa } from 'execa'
 import split from 'split2'
 import { join } from 'desm'
-
-// This file must be required/imported as the first file
-// in the test suite. It sets up the global environment
-// to track the open handles via why-is-node-running.
-setInterval(() => {
-  why()
-}, 20000).unref()
+import tap from 'tap'
 
 setGlobalDispatcher(new Agent({
   keepAliveTimeout: 10,
@@ -20,6 +13,12 @@ setGlobalDispatcher(new Agent({
   }
 }))
 
+// This should not be needed, but a weird combination
+// of node-tap, Windows, c8 and ESM makes this necessary.
+tap.teardown(() => {
+  process.exit(0)
+})
+
 export const cliPath = join(import.meta.url, '..', '..', 'service.mjs')
 
 export async function start (...args) {

package/test/cli/watch.test.mjs

@@ -19,8 +19,9 @@ function createLoggingPlugin (text, reloaded = false) {
   `
 }
 
-test('should watch js files by default', async ({ equal, teardown }) => {
+test('should watch js files by default', async ({ equal, teardown, comment }) => {
   const tmpDir = await mkdtemp(join(os.tmpdir(), 'watch-'))
+  comment(`using ${tmpDir}`)
   const pluginFilePath = join(tmpDir, 'plugin.js')
   const configFilePath = join(tmpDir, 'platformatic.service.json')
 
@@ -44,6 +45,8 @@ test('should watch js files by default', async ({ equal, teardown }) => {
   ])
 
   const { child, url } = await start('-c', configFilePath)
+  child.stdout.pipe(process.stderr)
+  child.stderr.pipe(process.stderr)
   teardown(() => child.kill('SIGINT'))
 
   await writeFile(pluginFilePath, createLoggingPlugin('v2', true))

package/test/clients.test.js

@@ -5,28 +5,22 @@ const { test } = require('tap')
 const { buildServer } = require('..')
 const { join } = require('path')
 const { request } = require('undici')
-const ConfigManager = require('../lib/config')
 const { compile } = require('../lib/compile')
 const { rmdir } = require('fs/promises')
 
-class NoLogConfigManager extends ConfigManager {
-  _transformConfig () {
-    super._transformConfig()
-    this.current.server.logger.level = 'error'
-  }
-}
-
-test('client is loaded', async ({ teardown, equal, pass, same }) => {
-  const server1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'platformatic.service.json'), undefined, NoLogConfigManager)
-  teardown(server1.stop)
+test('client is loaded', async ({ teardown, equal, pass, same, comment }) => {
+  const server1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'platformatic.service.json'))
   await server1.listen()
 
   process.env.PLT_CLIENT_URL = server1.url
 
-  const server2 = await buildServer(join(__dirname, '..', 'fixtures', 'hello-client', 'platformatic.service.json'), undefined, NoLogConfigManager)
-  teardown(server2.stop)
-  await server2.listen()
+  const server2 = await buildServer(join(__dirname, '..', 'fixtures', 'hello-client', 'platformatic.service.json'))
 
+  teardown(async () => {
+    await server2.stop()
+    await server1.stop()
+  })
+  await server2.listen()
   const res = await request(`${server2.url}/`)
   equal(res.statusCode, 200, 'status code')
   const data = await res.body.json()
@@ -34,8 +28,7 @@ test('client is loaded', async ({ teardown, equal, pass, same }) => {
 })
 
 test('client is loaded (ts)', async ({ teardown, equal, pass, same }) => {
-  const server1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'platformatic.service.json'), undefined, NoLogConfigManager)
-  teardown(server1.stop)
+  const server1 = await buildServer(join(__dirname, '..', 'fixtures', 'hello', 'platformatic.service.json'))
   await server1.listen()
 
   process.env.PLT_CLIENT_URL = server1.url
@@ -48,8 +41,11 @@ test('client is loaded (ts)', async ({ teardown, equal, pass, same }) => {
 
   await compile(targetDir)
 
-  const server2 = await buildServer(join(targetDir, 'platformatic.service.json'), undefined, NoLogConfigManager)
-  teardown(server2.stop)
+  const server2 = await buildServer(join(targetDir, 'platformatic.service.json'))
+  teardown(async () => {
+    await server2.stop()
+    await server1.stop()
+  })
   await server2.listen()
 
   const res = await request(`${server2.url}/`)

package/test/config.test.js

@@ -2,7 +2,7 @@
 
 require('./helper')
 const { test } = require('tap')
-const { buildServer, ConfigManager } = require('..')
+const { buildServer } = require('..')
 const { request } = require('undici')
 const { join } = require('path')
 const os = require('os')
@@ -226,69 +226,6 @@ test('config is adjusted to handle custom loggers', async (t) => {
   t.equal(called, true)
 })
 
-test('custom ConfigManager', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `${process.pid}-2.js`)
-
-  await writeFile(file, `
-    module.exports = async function (app, options) {
-      app.get('/', () => options.message)
-    }`)
-
-  class MyConfigManager extends ConfigManager {
-    _transformConfig () {
-      super._transformConfig.call(this)
-      this.current.plugins = {
-        paths: [{
-          path: file,
-          options: {
-            message: 'hello'
-          }
-        }]
-      }
-    }
-  }
-
-  const server = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    metrics: false
-  }, null, MyConfigManager)
-  teardown(server.stop)
-  await server.listen()
-
-  {
-    const res = await request(`${server.url}/`)
-    equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello', 'response')
-  }
-
-  await server.app.platformatic.configManager.update({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [{
-        path: file,
-        options: {
-          message: 'ciao mondo'
-        }
-      }]
-    },
-    metrics: false
-  })
-
-  await server.restart()
-
-  {
-    const res = await request(`${server.url}/`)
-    equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello', 'response')
-  }
-})
-
 test('config reloads', async ({ teardown, equal, pass, same }) => {
   const file = join(os.tmpdir(), `${process.pid}-1.js`)
 

package/test/fixtures/typescript-autoload/platformatic.service.json

@@ -9,5 +9,6 @@
   "plugins": {
     "paths": ["routes"],
     "typescript": true
-  }
-}
+  },
+  "watch": false
+}

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

@@ -9,5 +9,6 @@
   "plugins": {
     "paths": ["plugin.ts"],
     "typescript": true
-  }
+  },
+  "watch": false
 }

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

@@ -4,10 +4,12 @@
       "level": "info"
     },
     "hostname": "127.0.0.1",
-    "port": "0"
+    "port": "0",
+    "pluginTimeout": 60000
   },
   "plugins": {
     "paths": ["plugin.ts"],
     "typescript": false
-  }
+  },
+  "watch": false
 }

package/test/helper.js

@@ -1,14 +1,7 @@
 'use strict'
 
-const why = require('why-is-node-running')
 const { Agent, setGlobalDispatcher } = require('undici')
-
-// This file must be required/imported as the first file
-// in the test suite. It sets up the global environment
-// to track the open handles via why-is-node-running.
-setInterval(() => {
-  why()
-}, 20000).unref()
+const tap = require('tap')
 
 const agent = new Agent({
   keepAliveTimeout: 10,
@@ -17,8 +10,15 @@ const agent = new Agent({
     rejectUnauthorized: false
   }
 })
+
 setGlobalDispatcher(agent)
 
+// This should not be needed, but a weird combination
+// of node-tap, Windows, c8 and ESM makes this necessary.
+tap.teardown(() => {
+  process.exit(0)
+})
+
 function buildConfig (options) {
   const base = {
     server: {}

package/test/https.test.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const { mkdtempSync, writeFileSync } = require('fs')
+const { mkdtemp, writeFile } = require('fs/promises')
 const { tmpdir } = require('os')
 const { isAbsolute, join, relative } = require('path')
 const selfCert = require('self-cert')
@@ -9,17 +9,21 @@ const { Agent, setGlobalDispatcher, request } = require('undici')
 const { buildServer } = require('..')
 const { buildConfig } = require('./helper')
 
-test('supports https options', async ({ teardown, equal, same, plan }) => {
+test('supports https options', async ({ teardown, equal, same, plan, comment }) => {
   plan(7)
 
   const { certificate, privateKey } = selfCert({})
-  const tmpDir = mkdtempSync(join(tmpdir(), 'plt-service-https-test-'))
+  const localDir = tmpdir()
+  comment(`system tmpdir ${localDir}`)
+  const tmpDir = await mkdtemp(join(localDir, 'plt-service-https-test-'))
+  comment(`writing in ${tmpDir}`)
   const privateKeyPath = join(tmpDir, 'plt.key')
   const certificatePath = join(tmpDir, 'plt.cert')
-  const certificateRelativePath = relative(__dirname, certificatePath)
+  const certificateRelativePath = relative(process.cwd(), certificatePath)
+  comment(`certificate relative path ${certificateRelativePath}`)
 
-  writeFileSync(privateKeyPath, privateKey)
-  writeFileSync(certificatePath, certificate)
+  await writeFile(privateKeyPath, privateKey)
+  await writeFile(certificatePath, certificate)
 
   setGlobalDispatcher(new Agent({
     connect: {

package/lib/config.js

@@ -1,23 +0,0 @@
-'use strict'
-
-const ConfigManager = require('@platformatic/config')
-const { schema } = require('./schema')
-
-class ServiceConfigManager extends ConfigManager {
-  constructor (opts) {
-    super({
-      ...opts,
-      schema: opts.schema || schema,
-      schemaOptions: {
-        useDefaults: true,
-        coerceTypes: true,
-        allErrors: true,
-        strict: false
-      },
-      allowToWatch: ['.env'],
-      envWhitelist: ['PORT', ...(opts.envWhitelist || [])]
-    })
-  }
-}
-
-module.exports = ServiceConfigManager