@platformatic/service 0.24.0 → 0.26.0

package/index.js

@@ -112,6 +112,13 @@ platformaticService.configManagerConfig = {
     coerceTypes: true,
     allErrors: true,
     strict: false
+  },
+  transformConfig () {
+    // Set watch to true by default. This is not possible
+    // to do in the schema, because it is uses an anyOf.
+    if (this.current.watch === undefined) {
+      this.current.watch = true
+    }
   }
 }
 

package/lib/load-config.js

@@ -37,7 +37,10 @@ async function loadConfig (minimistConfig, _args, app, overrides = {}) {
     const configFiles = ConfigManager.listConfigFiles(configType)
     console.error(`
 Missing config file!
-Be sure to have a config file with one of the following names: ${configFiles.join('\n')}
+Be sure to have a config file with one of the following names:
+
+${configFiles.map((s) => ' * ' + s).join('\n')}
+
 In alternative run "npm create platformatic@latest" to generate a basic plt service config.
 Error: ${err}
 `)

package/lib/plugins/openapi.js

@@ -33,7 +33,9 @@ async function setupOpenAPI (app, opts) {
     }
   })
 
+  const { default: theme } = await import('@platformatic/swagger-ui-theme')
   app.register(SwaggerUI, {
+    ...theme,
     ...opts,
     prefix: '/documentation'
   })

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

@@ -94,6 +94,8 @@
       <img height="256" src="logo-512x512.png"/>
       <h1>Welcome to Platformatic Service</h1>
       <h2><a href="https://oss.platformatic.dev" target="_blank">Documentation</a></h2>
+      <h2><a href="/documentation" target="_blank">OpenAPI Documentation</a></h2>
+      <h2><a href="/graphiql" target="_blank">GraphiQL</a></h2>
     </div>
   </body>
 </html>

package/lib/utils.js

@@ -2,6 +2,7 @@
 
 const { access } = require('fs/promises')
 const { resolve, join, relative, dirname, basename } = require('path')
+const { isatty } = require('tty')
 
 async function isFileAccessible (filename, directory) {
   try {
@@ -23,7 +24,7 @@ function addLoggerToTheConfig (config) {
   }
 
   // If TTY use pino-pretty
-  if (process.stdout.isTTY) {
+  if (isatty(1)) {
     if (!logger.transport) {
       logger.transport = {
         target: 'pino-pretty'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.24.0",
+  "version": "0.26.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -29,8 +29,8 @@
     "tap": "^16.3.4",
     "tsd": "^0.28.1",
     "typescript": "^5.0.4",
-    "undici": "^5.22.0",
-    "vscode-json-languageservice": "^5.3.4",
+    "undici": "^5.22.1",
+    "vscode-json-languageservice": "^5.3.5",
     "why-is-node-running": "^2.2.2",
     "yaml": "^2.2.2"
   },
@@ -42,7 +42,7 @@
     "@fastify/deepmerge": "^1.3.0",
     "@fastify/restartable": "^2.1.0",
     "@fastify/static": "^6.10.1",
-    "@fastify/swagger": "^8.3.1",
+    "@fastify/swagger": "^8.5.1",
     "@fastify/swagger-ui": "^1.8.1",
     "@fastify/under-pressure": "^8.2.0",
     "@mercuriusjs/federation": "^2.0.0",
@@ -55,18 +55,19 @@
     "fastify": "^4.17.0",
     "fastify-metrics": "^10.3.0",
     "fastify-plugin": "^4.5.0",
-    "fastify-sandbox": "^0.12.0",
+    "fastify-sandbox": "^0.13.0",
     "graphql": "^16.6.0",
     "help-me": "^4.2.0",
     "mercurius": "^13.0.0",
     "minimist": "^1.2.8",
-    "pino": "^8.12.0",
+    "pino": "^8.14.1",
     "pino-pretty": "^10.0.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.35",
-    "@platformatic/client": "0.24.0",
-    "@platformatic/config": "0.24.0",
-    "@platformatic/utils": "0.24.0"
+    "@platformatic/swagger-ui-theme": "0.26.0",
+    "@platformatic/config": "0.26.0",
+    "@platformatic/utils": "0.26.0",
+    "@platformatic/client": "0.26.0"
   },
   "standard": {
     "ignore": [

package/test/config.test.js

@@ -29,6 +29,7 @@ test('config reloads', async ({ teardown, equal, pass, same }) => {
         }
       }]
     },
+    watch: false,
     metrics: false
   })
 

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

@@ -24,6 +24,7 @@ test('load and reload', async ({ teardown, equal, pass, same }) => {
     plugins: {
       paths: [file]
     },
+    watch: false,
     metrics: false
   })
 
@@ -71,6 +72,7 @@ test('error', async ({ teardown, equal, pass, match }) => {
     plugins: {
       paths: [file]
     },
+    watch: false,
     metrics: false
   })
 

package/test/watch.test.js

@@ -180,3 +180,69 @@ test('should stop watching typescript files after disabling watch option', async
     same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
   }
 })
+
+test('should watch files by default', async ({ teardown, equal, pass, same }) => {
+  const tmpDir = await mkdtemp(join(tmpdir(), 'platformatic.service.test-'))
+  const pathToPlugin = join(tmpDir, 'plugin.js')
+  const pathToConfig = join(tmpDir, 'platformatic.service.json')
+
+  teardown(async () => {
+    await rm(tmpDir, { recursive: true, force: true })
+  })
+
+  await writeFile(pathToPlugin, `
+    module.exports = async function plugin (app) {
+      app.get('/test', {}, async function (request, response) {
+        return { res: "plugin, version 1"}
+      })
+    }`)
+
+  const config = {
+    server: {
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    plugins: {
+      paths: [pathToPlugin],
+      stopTimeout: 1000,
+      hotReload: true
+    },
+    metrics: false
+  }
+
+  await writeFile(pathToConfig, JSON.stringify(config, null, 2))
+  const app = await buildServer(pathToConfig)
+
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
+  {
+    const res = await request(`${app.url}/test`, {
+      method: 'GET'
+    })
+    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
+  }
+
+  equal(app.fileWatcher.isWatching, true)
+
+  await writeFile(pathToPlugin, `
+    module.exports = async function plugin (app) {
+      app.get('/test', {}, async function (request, response) {
+        return { res: "plugin, version 2"}
+      })
+    }`)
+
+  // wait to be sure that app is not watching files anymore
+  await new Promise((resolve) => setTimeout(resolve, 5000))
+
+  {
+    const res = await request(`${app.url}/test`, {
+      method: 'GET'
+    })
+    equal(res.statusCode, 200)
+    // must be unchanged
+    same(await res.body.json(), { res: 'plugin, version 2' })
+  }
+})