@platformatic/service 0.26.1 → 0.28.1

package/test/autoload.test.js

@@ -47,99 +47,6 @@ test('autoload & filesystem based routing / watch disabled', async ({ teardown,
   }
 })
 
-test('autoload & filesystem based routing / watch enabled', async ({ teardown, equal }) => {
-  const config = {
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [join(__dirname, 'fixtures', 'directories', 'routes')]
-    },
-    watch: true,
-    metrics: false
-  }
-
-  const app = await buildServer(config)
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from root', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/bar`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from bar', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/baz`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from baz', 'body')
-  }
-})
-
-test('multiple files', async ({ teardown, equal }) => {
-  const config = {
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [{
-        path: join(__dirname, 'fixtures', 'directories', 'plugins')
-      }, {
-        path: join(__dirname, 'fixtures', 'directories', 'routes')
-      }]
-    },
-    watch: true,
-    metrics: false
-  }
-
-  const app = await buildServer(config)
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from root', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/bar`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from bar', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/baz`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from baz', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/with-decorator`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'bar', 'body')
-  }
-})
-
 test('multiple files / watch false', async ({ teardown, equal }) => {
   const config = {
     server: {
@@ -233,95 +140,6 @@ test('autoload & filesystem based routing / watch disabled / no object', async (
   }
 })
 
-test('autoload & filesystem based routing / watch enabled / no object', async ({ teardown, equal }) => {
-  const config = {
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [join(__dirname, 'fixtures', 'directories', 'routes')]
-    },
-    watch: true,
-    metrics: false
-  }
-
-  const app = await buildServer(config)
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from root', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/bar`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from bar', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/baz`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from baz', 'body')
-  }
-})
-
-test('multiple files / no object', async ({ teardown, equal }) => {
-  const config = {
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [join(__dirname, 'fixtures', 'directories', 'plugins'), join(__dirname, 'fixtures', 'directories', 'routes')]
-    },
-    watch: true,
-    metrics: false
-  }
-
-  const app = await buildServer(config)
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from root', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/bar`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from bar', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/baz`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'from baz', 'body')
-  }
-
-  {
-    const res = await request(`${app.url}/foo/with-decorator`)
-    equal(res.statusCode, 200, 'status code')
-    const body = await res.body.json()
-    equal(body.hello, 'bar', 'body')
-  }
-})
-
 test('multiple files / watch false / no object', async ({ teardown, equal }) => {
   const config = {
     server: {

package/test/cli/compile.test.mjs

@@ -164,7 +164,7 @@ t.test('start command should not compile typescript plugin with errors', async (
     await childProcess
     t.fail('should not compile bad typescript plugin')
   } catch (err) {
-    if (!err.stderr.includes('Found 1 error')) {
+    if (!err.stdout.includes('Found 1 error')) {
       t.comment(err.stdout)
       t.comment(err.stderr)
       t.fail('should throw one ts error')

package/test/cli/helper.mjs

@@ -41,8 +41,9 @@ export async function start (commandOpts, exacaOpts = {}) {
 
   for await (const messages of on(output, 'data')) {
     for (const message of messages) {
-      const url = message.url
-      if (url !== undefined) {
+      const text = message.msg
+      if (text && text.includes('Server listening at')) {
+        const url = text.match(/Server listening at (.*)/)[1]
         clearTimeout(errorTimeout)
         return { child, url, output }
       }

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

@@ -12,5 +12,5 @@
     "paths": ["plugin.ts"],
     "typescript": true
   },
-  "watch": true
+  "watch": false
 }

package/test/fixtures/nested-directories/modules/inventory/routes/product.js

@@ -1,4 +1,3 @@
-
 export default async function (fastify, opts) {
   fastify.get('/product/:sku', {
     schema: {

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

@@ -4,12 +4,13 @@ require('./helper')
 const { test } = require('tap')
 const { buildServer } = require('..')
 const { request, setGlobalDispatcher, getGlobalDispatcher, MockAgent } = require('undici')
+const { randomUUID } = require('crypto')
 const { join } = require('path')
 const os = require('os')
 const { writeFile } = require('fs/promises')
 
 test('load and reload', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `some-plugin-${process.pid}.js`)
+  const file = join(os.tmpdir(), `some-plugin-${randomUUID()}.js`)
 
   await writeFile(file, `
     module.exports = async function (app) {
@@ -50,12 +51,13 @@ test('load and reload', async ({ teardown, equal, pass, same }) => {
   {
     const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello world', 'response')
+    // The plugin is in Node's module cache, so the new value is not seen.
+    same(await res.body.json(), { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
   }
 })
 
 test('error', async ({ teardown, equal, pass, match }) => {
-  const file = join(os.tmpdir(), `some-plugin-${process.pid}.js`)
+  const file = join(os.tmpdir(), `some-plugin-${randomUUID()}.js`)
 
   await writeFile(file, `
     module.exports = async function (app) {
@@ -132,52 +134,6 @@ test('mock undici is supported', async ({ teardown, equal, pass, same }) => {
   })
 })
 
-test('load and reload with the fallback', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `some-plugin-${process.pid}.js`)
-
-  await writeFile(file, `
-    module.exports = async function (app) {
-    }`
-  )
-
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [file],
-      stopTimeout: 1000,
-      fallback: true
-    }
-  })
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/`)
-    equal(res.statusCode, 200, 'status code')
-    const data = await res.body.json()
-    same(data, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
-  }
-
-  await writeFile(file, `
-    module.exports = async function (app) {
-      app.get('/', () => "hello world" )
-    }`)
-
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/`)
-    equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello world', 'response')
-  }
-})
-
 test('load and reload ESM', async ({ teardown, equal, pass, same }) => {
   const file = join(os.tmpdir(), `some-plugin-${process.pid}.mjs`)
 
@@ -218,234 +174,7 @@ test('load and reload ESM', async ({ teardown, equal, pass, same }) => {
   {
     const res = await request(`${app.url}/`)
     equal(res.statusCode, 200, 'add status code')
-    same(await res.body.text(), 'hello world', 'response')
-  }
-})
-
-test('server should be available after reload a compromised plugin', async ({ teardown, equal, pass, same, rejects }) => {
-  const file = join(os.tmpdir(), `some-plugin-${process.pid}.js`)
-
-  const workingModule = `
-    module.exports = async function (app) {
-      (() => { /* console.log('loaded') */ })()
-    }`
-  const compromisedModule = '//console.log(\'loaded but server fails\')'
-  await writeFile(file, workingModule)
-
-  const config = {
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [file]
-    }
-  }
-
-  const app = await buildServer(config)
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  await writeFile(file, compromisedModule)
-  await app.restart().catch(() => {
-    pass('plugin reload failed')
-  })
-
-  {
-    const res = await request(`${app.url}/`, { method: 'GET' })
-    equal(res.statusCode, 200, 'status code')
-    const data = await res.body.json()
-    same(data, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
-  }
-
-  await writeFile(file, workingModule)
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/`, { method: 'GET' })
-    equal(res.statusCode, 200, 'add status code')
-    const data = await res.body.json()
-    same(data, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
-  }
-})
-
-test('hot reload disabled, CommonJS', async ({ teardown, equal, pass, same }) => {
-  const file = join(os.tmpdir(), `some-plugin-hot-rel-test-${process.pid}.js`)
-
-  await writeFile(file, `
-    module.exports = async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 1"}
-      })
-    }`
-  )
-
-  const app = await buildServer({
-    server: {
-      hostname: '127.0.0.1',
-      port: 0
-    },
-    plugins: {
-      paths: [file],
-      hotReload: false
-    }
-  })
-
-  teardown(async () => {
-    await app.close()
-  })
-  await app.start()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
-  }
-
-  await writeFile(file, `
-    module.exports = async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 2"}
-      })
-    }`
-  )
-
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    // must be unchanged
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
-  }
-})
-
-test('hot reload disabled, ESM', async ({ teardown, equal, pass, same }) => {
-  const pathToPlugin = join(os.tmpdir(), `some-plugin-hot-rel-test-${process.pid}.mjs`)
-  const pathToConfig = join(os.tmpdir(), `platformatic.service.${process.pid}.json`)
-
-  await writeFile(pathToPlugin, `
-    export default async function (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: false
-    },
-    watch: 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'
-    })
-    equal(res.statusCode, 200)
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
-  }
-
-  await writeFile(pathToPlugin, `
-    export default async function (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 2"}
-      })
-    }`
-  )
-
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    // must be unchanged
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
-  }
-})
-
-test('hot reload disabled, with default export', async ({ teardown, equal, pass, same }) => {
-  const pathToPlugin = join(os.tmpdir(), `some-plugin-hot-rel-test-${process.pid}.js`)
-  const pathToConfig = join(os.tmpdir(), `platformatic.service.${process.pid}.json`)
-
-  await writeFile(pathToPlugin, `
-    Object.defineProperty(exports, "__esModule", { value: true })
-    exports.default = 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: false
-    },
-    watch: 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')
-  }
-
-  await writeFile(pathToPlugin, `
-    Object.defineProperty(exports, "__esModule", { value: true })
-    exports.default = async function plugin (app) {
-      app.get('/test', {}, async function (request, response) {
-        return { res: "plugin, version 2"}
-      })
-    }`
-  )
-
-  await app.restart()
-
-  {
-    const res = await request(`${app.url}/test`, {
-      method: 'GET'
-    })
-    equal(res.statusCode, 200)
-    // must be unchanged
-    same(await res.body.json(), { res: 'plugin, version 1' }, 'get rest plugin')
+    // The plugin is in Node's module cache, so the new value is not seen.
+    same(await res.body.json(), { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
   }
 })

package/test/utils.test.js

@@ -28,3 +28,10 @@ test('isFileAccessible no dir', async (t) => {
   const file = resolve(join(__dirname, '..', 'fixtures', 'hello', 'platformatic.service.json'))
   t.equal(await isFileAccessible(file), true)
 })
+
+test('should return the same plugin folder if it\'s already the compiled one', (t) => {
+  t.plan(1)
+
+  const result = getJSPluginPath('/something', '/something/dist/plugins', '/something/dist')
+  t.equal(result, '/something/dist/plugins')
+})

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "module": "CommonJS",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "es2019",
+    "outDir": "build",
+    "sourceMap": true,
+    "strictNullChecks": true
+  }
+}

package/lib/plugins/file-watcher.js

@@ -1,44 +0,0 @@
-'use strict'
-
-const { FileWatcher } = require('@platformatic/utils')
-const fp = require('fastify-plugin')
-
-async function setupFileWatcher (app, opts) {
-  // TODO: move params to opts
-
-  const configManager = app.platformatic.configManager
-  const config = configManager.current
-
-  const isRestartableApp = app.restarted !== undefined
-
-  // to run the plugin without restartable
-  /* c8 ignore next 1 */
-  const persistentRef = isRestartableApp ? app.persistentRef : app
-
-  let fileWatcher = persistentRef.fileWatcher
-  if (!fileWatcher) {
-    fileWatcher = new FileWatcher({
-      path: configManager.dirname,
-      allowToWatch: config.watch?.allow,
-      watchIgnore: config.watch?.ignore
-    })
-
-    fileWatcher.on('update', () => {
-      opts.onFilesUpdated(persistentRef)
-    })
-
-    app.log.debug('start watching files')
-    fileWatcher.startWatching()
-  }
-
-  app.decorate('fileWatcher', fileWatcher)
-
-  app.addHook('onClose', async () => {
-    if (!isRestartableApp || app.closingRestartable) {
-      app.fileWatcher.stopWatching()
-      app.log.debug('stop watching files')
-    }
-  })
-}
-
-module.exports = fp(setupFileWatcher)