@platformatic/service 3.4.1 → 3.5.0

package/lib/plugins/plugins.js

@@ -1,57 +1,10 @@
-'use strict'
+import fp from 'fastify-plugin'
+import { sandboxWrapper } from './sandbox-wrapper.js'
 
-const { join, resolve } = require('path')
-const { readFile } = require('fs/promises')
-const fp = require('fastify-plugin')
-const wrapper = require('./sandbox-wrapper')
+async function loadPluginsPlugin (app, context) {
+  const config = app.platformatic.config
 
-const { getJSPluginPath, isFileAccessible } = require('../utils')
-
-async function loadPlugins (app, opts) {
-  const configManager = app.platformatic.configManager
-  const config = configManager.current
-
-  let isOutDirAccessible = false
-  let outDir = null
-
-  const workingDir = opts?.context?.directory ?? configManager.dirname
-  const tsConfigPath = configManager.current.plugins.typescript?.tsConfig || join(workingDir, 'tsconfig.json')
-
-  // If the tsconfig.json file exists, then we need to adjust the plugin paths
-  // to point to the compiled JS files.
-  const isTsConfigAccessible = await isFileAccessible(tsConfigPath)
-  if (isTsConfigAccessible) {
-    const tsConfig = JSON.parse(await readFile(tsConfigPath, 'utf8'))
-    outDir = resolve(workingDir, tsConfig.compilerOptions.outDir)
-  }
-
-  /* c8 ignore next 3 */
-  if (configManager.current.plugins.typescript?.outDir) {
-    outDir = configManager.current.plugins.typescript.outDir
-  }
-
-  if (outDir) {
-    isOutDirAccessible = await isFileAccessible(outDir)
-
-    if (opts.context?.isProduction && !isOutDirAccessible) {
-      throw new Error(
-        `Cannot access directory '${outDir}'. Please run the 'build' command before running in production mode.`
-      )
-    }
-  }
-
-  if (config.plugins.paths && isOutDirAccessible) {
-    config.plugins.paths = config.plugins.paths.map(plugin => {
-      /* c8 ignore next 3 */
-      const tmp =
-        typeof plugin === 'string'
-          ? getJSPluginPath(workingDir, plugin, outDir)
-          : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
-      return tmp
-    })
-  }
-
-  await app.register(wrapper, { packages: config.plugins.packages, paths: config.plugins.paths })
+  await app.register(sandboxWrapper, { packages: config.plugins.packages, paths: config.plugins.paths })
 }
 
-module.exports = fp(loadPlugins)
+export const loadPlugins = fp(loadPluginsPlugin)

package/lib/{root-endpoint/index.js → plugins/root.js}

@@ -1,12 +1,11 @@
-'use strict'
+import fastifyStatic from '@fastify/static'
+import fp from 'fastify-plugin'
+import userAgentParser from 'my-ua-parser'
+import { join } from 'node:path'
 
-const path = require('path')
-const fastifyStatic = require('@fastify/static')
-const userAgentParser = require('my-ua-parser')
-
-module.exports = async (app, opts) => {
+async function setupRootPlugin (app) {
   app.register(fastifyStatic, {
-    root: path.join(__dirname, 'public'),
+    root: join(import.meta.dirname, '../../public')
   })
 
   // root endpoint
@@ -23,6 +22,8 @@ module.exports = async (app, opts) => {
         }
       }
       return { message: 'Welcome to Platformatic! Please visit https://docs.platformatic.dev' }
-    },
+    }
   })
 }
+
+export const setupRoot = fp(setupRootPlugin)

package/lib/plugins/sandbox-wrapper.js

@@ -1,61 +1,10 @@
-'use strict'
-
-const fp = require('fastify-plugin')
-const autoload = require('@fastify/autoload')
-const { stat } = require('node:fs').promises
-const { createRequire } = require('node:module')
-const { join } = require('node:path')
-const { pathToFileURL } = require('node:url')
-
-module.exports = fp(async function (app, opts) {
-  // fake require next to the configManager dirname
-  const _require = createRequire(join(app.platformatic.configManager.dirname, 'package.json'))
-  for (const plugin of opts.packages || []) {
-    const name = typeof plugin === 'string' ? plugin : plugin.name
-    const url = pathToFileURL(_require.resolve(name))
-    const loaded = await import(url)
-    await app.register(loaded, plugin.options)
-  }
-
-  for (let plugin of opts.paths || []) {
-    if (typeof plugin === 'string') {
-      plugin = { path: plugin, encapsulate: true }
-    }
-    if (plugin.path && (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,
-        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(pathToFileURL(plugin.path))
-      /* c8 ignore next 3 */
-      if (loaded.__esModule === true || typeof loaded.default === 'function') {
-        loaded = loaded.default
-      }
-
-      if (plugin.encapsulate === false) {
-        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)
-      }
-    }
-  }
-})
+import autoload from '@fastify/autoload'
+import { kMetadata } from '@platformatic/foundation'
+import fp from 'fastify-plugin'
+import { stat } from 'node:fs/promises'
+import { createRequire } from 'node:module'
+import { isAbsolute, resolve } from 'node:path'
+import { pathToFileURL } from 'node:url'
 
 /**
  * Creates an object for pattern specific options. This ensures that
@@ -68,11 +17,7 @@ function patternOptionsFromPlugin (plugin) {
   const config = {}
 
   // Expected keys for autoload plugin options that expect regexp patterns
-  const patternOptionKeys = [
-    'ignorePattern',
-    'indexPattern',
-    'autoHooksPattern',
-  ]
+  const patternOptionKeys = ['ignorePattern', 'indexPattern', 'autoHooksPattern']
 
   for (const key of patternOptionKeys) {
     const pattern = plugin[key]
@@ -104,3 +49,60 @@ function stringPatternToRegExp (stringPattern) {
     return undefined
   }
 }
+
+async function sandboxWrapperPlugin (app, options) {
+  const require = createRequire(resolve(app.platformatic.config[kMetadata].root, 'noop.js'))
+
+  for (const plugin of options.packages || []) {
+    const name = typeof plugin === 'string' ? plugin : plugin.name
+    const url = pathToFileURL(require.resolve(name))
+    const loaded = await import(url)
+    await app.register(loaded, plugin.options)
+  }
+
+  for (let plugin of options.paths || []) {
+    if (typeof plugin === 'string') {
+      plugin = { path: plugin, encapsulate: true }
+    }
+
+    if (plugin.path && !isAbsolute(plugin.path)) {
+      plugin.path = resolve(app.platformatic.config[kMetadata].root, plugin.path)
+    }
+
+    if (plugin.path && (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,
+        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(pathToFileURL(plugin.path))
+      /* c8 ignore next 3 */
+      if (loaded.__esModule === true || typeof loaded.default === 'function') {
+        loaded = loaded.default
+      }
+
+      if (plugin.encapsulate === false) {
+        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)
+      }
+    }
+  }
+}
+
+export const sandboxWrapper = fp(sandboxWrapperPlugin)