@platformatic/service 0.22.0 → 0.23.1

package/test/routes.test.js

@@ -7,7 +7,7 @@ const { request } = require('undici')
 const { join } = require('path')
 
 test('should respond 200 on root endpoint', async ({ teardown, equal, same }) => {
-  const server = await buildServer(buildConfig({
+  const app = await buildServer(buildConfig({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -17,12 +17,15 @@ test('should respond 200 on root endpoint', async ({ teardown, equal, same }) =>
       }
     }
   }))
-  teardown(server.stop)
 
-  await server.listen()
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   {
     // No browser (i.e. curl)
-    const res = await (request(`${server.url}/`))
+    const res = await (request(`${app.url}/`))
     equal(res.statusCode, 200)
     const body = await res.body.json()
     same(body, { message: 'Welcome to Platformatic! Please visit https://oss.platformatic.dev' })
@@ -30,7 +33,7 @@ test('should respond 200 on root endpoint', async ({ teardown, equal, same }) =>
 
   {
     // browser
-    const res = await (request(`${server.url}/`, {
+    const res = await (request(`${app.url}/`, {
       headers: {
         'user-agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36'
       }
@@ -42,7 +45,7 @@ test('should respond 200 on root endpoint', async ({ teardown, equal, same }) =>
 })
 
 test('should not overwrite a plugin which define a root endpoint', async ({ teardown, equal, same }) => {
-  const server = await buildServer(buildConfig({
+  const app = await buildServer(buildConfig({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -55,17 +58,20 @@ test('should not overwrite a plugin which define a root endpoint', async ({ tear
       paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
     }
   }))
-  teardown(server.stop)
 
-  await server.listen()
-  const res = await (request(`${server.url}/`))
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
+  const res = await (request(`${app.url}/`))
   equal(res.statusCode, 200)
   const body = await res.body.json()
   same(body, { message: 'Root Plugin' })
 })
 
 test('openapi enabled', async ({ teardown, equal, same }) => {
-  const server = await buildServer(buildConfig({
+  const app = await buildServer(buildConfig({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -81,12 +87,15 @@ test('openapi enabled', async ({ teardown, equal, same }) => {
       paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
     }
   }))
-  teardown(server.stop)
 
-  await server.listen()
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   {
     // No browser (i.e. curl)
-    const res = await (request(`${server.url}/documentation/json`))
+    const res = await (request(`${app.url}/documentation/json`))
     equal(res.statusCode, 200)
     const body = await res.body.json()
 
@@ -98,7 +107,7 @@ test('openapi enabled', async ({ teardown, equal, same }) => {
 })
 
 test('openapi config', async ({ teardown, equal, same }) => {
-  const server = await buildServer(buildConfig({
+  const app = await buildServer(buildConfig({
     server: {
       hostname: '127.0.0.1',
       port: 0
@@ -116,12 +125,15 @@ test('openapi config', async ({ teardown, equal, same }) => {
       paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
     }
   }))
-  teardown(server.stop)
 
-  await server.listen()
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   {
     // No browser (i.e. curl)
-    const res = await (request(`${server.url}/documentation/json`))
+    const res = await (request(`${app.url}/documentation/json`))
     equal(res.statusCode, 200)
     const body = await res.body.json()
 
@@ -134,7 +146,7 @@ test('openapi config', async ({ teardown, equal, same }) => {
 })
 
 test('openapi disabled', async ({ teardown, equal, same }) => {
-  const server = await buildServer(buildConfig({
+  const app = await buildServer(buildConfig({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -150,19 +162,22 @@ test('openapi disabled', async ({ teardown, equal, same }) => {
       paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
     }
   }))
-  teardown(server.stop)
 
-  await server.listen()
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   {
     // No browser (i.e. curl)
-    const res = await (request(`${server.url}/documentation/json`))
+    const res = await (request(`${app.url}/documentation/json`))
     equal(res.statusCode, 404)
     await res.body.text()
   }
 })
 
 test('openapi disabled by default', async ({ teardown, equal, same }) => {
-  const server = await buildServer(buildConfig({
+  const app = await buildServer(buildConfig({
     server: {
       hostname: '127.0.0.1',
       port: 0,
@@ -175,12 +190,15 @@ test('openapi disabled by default', async ({ teardown, equal, same }) => {
       paths: [join(__dirname, 'fixtures', 'root-endpoint-plugin.js')]
     }
   }))
-  teardown(server.stop)
 
-  await server.listen()
+  teardown(async () => {
+    await app.close()
+  })
+  await app.start()
+
   {
     // No browser (i.e. curl)
-    const res = await (request(`${server.url}/documentation/json`))
+    const res = await (request(`${app.url}/documentation/json`))
     equal(res.statusCode, 404)
     await res.body.text()
   }

package/test/utils.test.js

@@ -7,7 +7,7 @@ const { join, resolve } = require('path')
 test('should get the path of a TS plugin', (t) => {
   t.plan(1)
 
-  const result = getJSPluginPath('/something/platformatic.service.json', '/something/plugin.ts', '/something/dist')
+  const result = getJSPluginPath('/something', '/something/plugin.ts', '/something/dist')
   const expected = join('/something', 'dist', 'plugin.js')
   t.equal(result, expected)
 })
@@ -15,7 +15,7 @@ test('should get the path of a TS plugin', (t) => {
 test('should get the path of a JS plugin', (t) => {
   t.plan(1)
 
-  const result = getJSPluginPath('/something/platformatic.service.json', '/something/plugin.js', '/something/dist')
+  const result = getJSPluginPath('/something', '/something/plugin.js', '/something/dist')
   t.equal(result, '/something/plugin.js')
 })
 

package/test/watch.test.js

@@ -0,0 +1,182 @@
+'use strict'
+
+const { join } = require('path')
+const { tmpdir } = require('os')
+const { writeFile, mkdtemp, rm } = require('fs/promises')
+
+const { test } = require('tap')
+const { request } = require('undici')
+
+const { buildServer } = require('..')
+require('./helper')
+
+test('should stop watching files after disabling watch option', 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
+    },
+    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')
+  }
+
+  equal(app.fileWatcher.isWatching, true)
+
+  await app.platformatic.configManager.update({ ...config, watch: false })
+  await app.restart()
+
+  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))
+
+  equal(app.fileWatcher, undefined)
+
+  {
+    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('should stop watching typescript files after disabling watch option', async ({ teardown, equal, ok, same }) => {
+  const tmpDir = await mkdtemp(join(tmpdir(), 'platformatic.service.test-'))
+  const pathToPlugin = join(tmpDir, 'plugin.ts')
+  const pathToConfig = join(tmpDir, 'platformatic.service.json')
+  const pathToTsConfig = join(tmpDir, 'tsconfig.json')
+
+  teardown(async () => {
+    await rm(tmpDir, { recursive: true, force: true })
+  })
+
+  const tsConfig = {
+    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'
+      ]
+    }
+  }
+
+  await writeFile(pathToPlugin, `
+    export 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: true,
+      typescript: true
+    },
+    watch: true,
+    metrics: false
+  }
+
+  await writeFile(pathToConfig, JSON.stringify(config, null, 2))
+  await writeFile(pathToTsConfig, JSON.stringify(tsConfig, 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')
+  }
+
+  ok(app.tsCompilerWatcher)
+
+  await app.platformatic.configManager.update({ ...config, watch: false })
+  await app.restart()
+
+  await writeFile(pathToPlugin, `
+    export default 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, 10000))
+
+  equal(app.tsCompilerWatcher, undefined)
+
+  {
+    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')
+  }
+})