@platformatic/service 0.33.1 → 0.34.1

package/index.js

@@ -1,6 +1,8 @@
 'use strict'
 
 const { isKeyEnabled } = require('@platformatic/utils')
+const { readFile } = require('fs/promises')
+const { dirname, join } = require('path')
 
 const compiler = require('./lib/compile')
 const setupCors = require('./lib/plugins/cors')
@@ -65,13 +67,6 @@ async function platformaticService (app, opts, toLoad = []) {
     await app.register(loadPlugins)
   }
 
-  if (isKeyEnabled('watch', config)) {
-    // If file watching is enabled here, that means the service was started
-    // without the runtime because the runtime explicitly disables watching on
-    // services that it starts. Warn the user that things will not go as planned.
-    app.log.warn('service was started with file watching enabled but watching is only available via the runtime')
-  }
-
   if (config.server.cors) {
     app.register(setupCors, config.server.cors)
   }
@@ -98,11 +93,32 @@ platformaticService.configManagerConfig = {
     allErrors: true,
     strict: false
   },
-  transformConfig () {
+  async 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
+      this.current.watch = { enabled: false }
+    }
+
+    if (typeof this.current.watch !== 'object') {
+      this.current.watch = { enabled: this.current.watch || false }
+    }
+
+    const typescript = this.current.plugins?.typescript
+    if (typescript) {
+      let outDir = typescript.outDir
+      if (outDir === undefined) {
+        let tsConfigFile = typescript.tsConfigFile || 'tsconfig.json'
+        tsConfigFile = join(dirname(this.fullPath), tsConfigFile)
+        try {
+          const tsConfig = JSON.parse(await readFile(tsConfigFile, 'utf8'))
+          outDir = tsConfig.compilerOptions.outDir
+        } catch {}
+        outDir ||= 'dist'
+      }
+
+      this.current.watch.ignore ||= []
+      this.current.watch.ignore.push(outDir + '/**/*')
     }
   }
 }

package/lib/plugins/sandbox-wrapper.js

@@ -10,11 +10,21 @@ module.exports = fp(async function (app, opts) {
       plugin = { path: plugin, encapsulate: true }
     }
     if ((await stat(plugin.path)).isDirectory()) {
+      const patternOptions = patternOptionsFromPlugin(plugin)
+
       app.register(autoload, {
         dir: plugin.path,
         encapsulate: plugin.encapsulate !== false,
         maxDepth: plugin.maxDepth,
-        options: plugin.options
+        options: plugin.options,
+        autoHooks: plugin.autoHooks,
+        cascadeHooks: plugin.cascadeHooks,
+        overwriteHooks: plugin.overwriteHooks,
+        routeParams: plugin.routeParams,
+        forceESM: plugin.forceESM,
+        ignoreFilter: plugin.ignoreFilter,
+        matchFilter: plugin.matchFilter,
+        ...patternOptions
       })
     } else {
       let loaded = await import(`file://${plugin.path}`)
@@ -23,13 +33,58 @@ module.exports = fp(async function (app, opts) {
         loaded = loaded.default
       }
 
-      let skipOverride
       if (plugin.encapsulate === false) {
-        skipOverride = loaded[Symbol.for('skip-override')]
+        const skipOverride = loaded[Symbol.for('skip-override')]
         loaded[Symbol.for('skip-override')] = true
+        await app.register(loaded, plugin.options)
+        loaded[Symbol.for('skip-override')] = skipOverride
+      } else {
+        await app.register(loaded, plugin.options)
       }
-      await app.register(loaded, plugin.options)
-      loaded[Symbol.for('skip-override')] = skipOverride
     }
   }
 })
+
+/**
+ * Creates an object for pattern specific options. This ensures that
+ * only configurations that have been provided are included in the
+ * final result. This prevents 'cannot read properties of undefined'
+ * errors when undefined configs are provided to the underlying
+ * @fastify/autoload plugin.
+ */
+function patternOptionsFromPlugin (plugin) {
+  const config = {}
+
+  // Expected keys for autoload plugin options that expect regexp patterns
+  const patternOptionKeys = ['ignorePattern', 'indexPattern', 'autoHooksPattern']
+
+  for (const key of patternOptionKeys) {
+    const pattern = plugin[key]
+
+    // If pattern key not found in plugin object, move on
+    if (!pattern) {
+      continue
+    }
+
+    // Build an instance of a RegExp. If this comes back undefined,
+    // then an invalid value was provided. Move on.
+    const regExpPattern = stringPatternToRegExp(pattern)
+    if (!regExpPattern) {
+      continue
+    }
+
+    // We have a valid RegExp so add the option to the config to pass along to
+    // autoload.
+    config[key] = regExpPattern
+  }
+
+  return config
+}
+
+function stringPatternToRegExp (stringPattern) {
+  try {
+    return new RegExp(stringPattern)
+  } catch (err) {
+    return undefined
+  }
+}

package/lib/schema.js

@@ -328,12 +328,21 @@ const server = {
     },
     cors
   },
+  additionalProperties: false,
   required: ['hostname', 'port']
 }
 
 const watch = {
   type: 'object',
   properties: {
+    enabled: {
+      default: true,
+      anyOf: [{
+        type: 'boolean'
+      }, {
+        type: 'string'
+      }]
+    },
     allow: {
       type: 'array',
       items: {
@@ -379,6 +388,39 @@ const plugins = {
             maxDepth: {
               type: 'integer'
             },
+            autoHooks: {
+              type: 'boolean'
+            },
+            autoHooksPattern: {
+              type: 'string'
+            },
+            cascadeHooks: {
+              type: 'boolean'
+            },
+            overwriteHooks: {
+              type: 'boolean'
+            },
+            routeParams: {
+              type: 'boolean'
+            },
+            forceESM: {
+              type: 'boolean'
+            },
+            ignoreFilter: {
+              type: 'string'
+            },
+            matchFilter: {
+              type: 'string'
+            },
+            ignorePattern: {
+              type: 'string'
+            },
+            scriptPattern: {
+              type: 'string'
+            },
+            indexPattern: {
+              type: 'string'
+            },
             options: {
               type: 'object',
               additionalProperties: true

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "0.33.1",
+  "version": "0.34.1",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -65,12 +65,12 @@
     "pino-pretty": "^10.0.0",
     "rfdc": "^1.3.0",
     "ua-parser-js": "^1.0.35",
-    "@platformatic/client": "0.33.1",
-    "@platformatic/config": "0.33.1",
-    "@platformatic/swagger-ui-theme": "0.33.1",
-    "@platformatic/types": "0.33.1",
-    "@platformatic/utils": "0.33.1",
-    "@platformatic/telemetry": "0.33.1"
+    "@platformatic/client": "0.34.1",
+    "@platformatic/config": "0.34.1",
+    "@platformatic/swagger-ui-theme": "0.34.1",
+    "@platformatic/types": "0.34.1",
+    "@platformatic/utils": "0.34.1",
+    "@platformatic/telemetry": "0.34.1"
   },
   "standard": {
     "ignore": [

package/test/autoload.test.js

@@ -342,3 +342,145 @@ test('disable encapsulation for a single file / different order', async ({ teard
     equal(body, 'bar')
   }
 })
+
+test('autoload with ignorePattern, indexPattern and autoHooksPattern options', async ({ teardown, equal }) => {
+  const config = {
+    server: {
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    plugins: {
+      paths: [
+        {
+          path: join(__dirname, 'fixtures', 'directories', 'routes'),
+
+          // Ignore the bar.js which should return a 404 for requests made to /bar
+          ignorePattern: '^.*(?:bar).js$',
+
+          // Set index2.js as the index file which sets the root as /index2
+          indexPattern: '^index2(?:.js)$',
+
+          // Override default autohooks.js with auto.hooks.js which overrides
+          // the response body
+          autoHooksPattern: '^auto.hooks.js$',
+          autoHooks: true
+        }
+      ]
+    },
+    watch: false,
+    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, 404, 'status code')
+  }
+
+  {
+    const res = await request(`${app.url}/foo/baz/index2`)
+    equal(res.statusCode, 200, 'status code')
+    const body = await res.body.json()
+    equal(body.hello, 'from baz with index2.js', 'body')
+  }
+
+  {
+    const res = await request(`${app.url}/oof`)
+    equal(res.statusCode, 200, 'status code')
+    const body = await res.body.json()
+    equal(body.hello, 'from auto.hooks.js', 'body')
+  }
+})
+
+test('autoload with INVALID ignorePattern, indexPattern and autoHooksPattern options', async ({ teardown, equal }) => {
+  const config = {
+    server: {
+      hostname: '127.0.0.1',
+      port: 0
+    },
+    plugins: {
+      paths: [
+        {
+          path: join(__dirname, 'fixtures', 'directories', 'routes'),
+          ignorePattern: '***',
+          indexPattern: '***terrible)))_pattern',
+          autoHooksPattern: ''
+        }
+      ]
+    },
+    watch: false,
+    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')
+  }
+})
+
+test('loads encapsulated plugin twice', async ({ teardown, equal, strictSame }) => {
+  const config = {
+    server: {
+      hostname: '127.0.0.1',
+      port: 0,
+      // Windows CI is slow
+      pluginTimeout: 60 * 1000
+    },
+    service: {
+      openapi: true
+    },
+    plugins: {
+      paths: [{
+        path: join(__dirname, 'fixtures', 'directories', 'routes')
+      }, {
+        path: join(__dirname, 'fixtures', 'directories', 'plugins', 'decorator.js')
+      }]
+    }
+  }
+
+  {
+    // First time plugin is loaded from file
+    const app = await buildServer(config)
+    teardown(async () => {
+      await app.close()
+    })
+    await app.start()
+
+    const res = await request(`${app.url}/foo/with-decorator`)
+    equal(res.statusCode, 200, 'status code')
+    const body = await res.body.json()
+    strictSame(body, { hello: 'bar' })
+  }
+
+  {
+    // Second time plugin is loaded from cache
+    const app = await buildServer(config)
+    teardown(async () => {
+      await app.close()
+    })
+    await app.start()
+
+    const res = await request(`${app.url}/foo/with-decorator`)
+    equal(res.statusCode, 200, 'status code')
+    const body = await res.body.json()
+    strictSame(body, { hello: 'bar' })
+  }
+})

package/test/config.test.js

@@ -6,7 +6,7 @@ const { buildServer } = require('..')
 const { request } = require('undici')
 const { join } = require('path')
 const os = require('os')
-const { writeFile } = require('fs/promises')
+const { writeFile, rm } = require('fs/promises')
 
 test('config reloads', async ({ teardown, equal, pass, same }) => {
   const file = join(os.tmpdir(), `${process.pid}-1.js`)
@@ -295,3 +295,22 @@ test('config reloads', async ({ teardown, equal, pass, same }) => {
     same(await res.body.text(), 'ciao mondo', 'response')
   }
 })
+
+test('do not watch typescript outDir', async ({ teardown, equal, pass, same }) => {
+  process.env.PLT_CLIENT_URL = 'http://localhost:3042'
+  const targetDir = join(__dirname, '..', 'fixtures', 'hello-client-ts')
+
+  try {
+    await rm(join(targetDir, 'dist'), { recursive: true })
+  } catch {}
+
+  const app = await buildServer(join(targetDir, 'platformatic.service.json'))
+  teardown(async () => {
+    await app.close()
+  })
+
+  same(app.platformatic.configManager.current.watch, {
+    enabled: false,
+    ignore: ['dist/**/*']
+  })
+})

package/test/fixtures/directories/routes/foo/baz/index2.js

@@ -0,0 +1,11 @@
+'use strict'
+
+/*
+ * Used for providing an alternative `index.js` naming convention
+ * when specified from the autoload `indexPattern` property.
+ */
+module.exports = async function (fastify, opts) {
+  fastify.get('/index2', async function (request, reply) {
+    return { hello: 'from baz with index2.js' }
+  })
+}

package/test/fixtures/directories/routes/oof/auto.hooks.js

@@ -0,0 +1,5 @@
+module.exports = async function (app, opts) {
+  app.addHook('onRequest', async (req, reply) => {
+    reply.send({ hello: 'from auto.hooks.js' })
+  })
+}

package/test/fixtures/directories/routes/oof/index.js

@@ -0,0 +1,7 @@
+'use strict'
+
+module.exports = async function (fastify, opts) {
+  fastify.get('/', async function (request, reply) {
+    return { hello: 'from oof' }
+  })
+}

package/test/telemetry.test.js

@@ -81,7 +81,7 @@ test('should setup telemetry if configured', async ({ teardown, equal, pass, sam
   equal(finishedSpans.length, 1)
   const span = finishedSpans[0]
   equal(span.name, 'GET /')
-  equal(span.attributes['req.method'], 'GET')
-  equal(span.attributes['req.url'], '/')
-  equal(span.attributes['reply.statusCode'], 200)
+  equal(span.attributes['http.request.method'], 'GET')
+  equal(span.attributes['url.path'], '/')
+  equal(span.attributes['http.response.status_code'], 200)
 })