@platformatic/service 0.27.0 → 0.29.0

package/fixtures/hello/platformatic.service.json

@@ -8,8 +8,7 @@
     }
   },
   "plugins": {
-    "paths": ["./plugin.js"],
-    "hotReload": false
+    "paths": ["./plugin.js"]
   },
   "service": {
     "openapi": true

package/fixtures/hello/warn-log.service.json

@@ -8,8 +8,7 @@
     }
   },
   "plugins": {
-    "paths": ["./plugin.js"],
-    "hotReload": false
+    "paths": ["./plugin.js"]
   },
   "service": {
     "openapi": true

package/fixtures/hello-client/platformatic.service.json

@@ -8,11 +8,10 @@
     }
   },
   "plugins": {
-    "paths": ["./plugin.js"],
-    "hotReload": false
+    "paths": ["./plugin.js"]
   },
   "clients": [{
-    "path": "./hello",
+    "path": "hello",
     "url": "{PLT_CLIENT_URL}"
   }],
   "metrics": false,

package/fixtures/hello-client-ts/platformatic.service.json

@@ -10,11 +10,10 @@
   },
   "plugins": {
     "paths": ["./plugin.ts"],
-    "typescript": true,
-    "hotReload": false
+    "typescript": true
   },
   "clients": [{
-    "path": "./hello",
+    "path": "hello",
     "url": "{PLT_CLIENT_URL}"
   }],
   "metrics": false,

package/fixtures/hello-client-ts-without-deps/hello.d.ts

@@ -0,0 +1,34 @@
+import { FastifyPluginAsync } from 'fastify'
+
+interface GetRequest {
+}
+
+interface GetResponse {
+}
+
+interface Hello {
+  get(req: GetRequest): Promise<GetResponse>;
+}
+
+type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    'hello': Hello;
+  }
+
+  interface FastifyRequest {
+    'hello': Hello;
+  }
+}
+
+declare namespace hello {
+  export interface HelloOptions {
+    url: string
+  }
+  export const hello: HelloPlugin;
+  export { hello as default };
+}
+
+declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
+export = hello;

package/fixtures/hello-client-ts-without-deps/hello.openapi.json

@@ -0,0 +1,22 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Platformatic",
+    "description": "This is a service built on top of Platformatic",
+    "version": "1.0.0"
+  },
+  "components": {
+    "schemas": {}
+  },
+  "paths": {
+    "/": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Default Response"
+          }
+        }
+      }
+    }
+  }
+}

package/fixtures/hello-client-ts-without-deps/platformatic.service.json

@@ -0,0 +1,23 @@
+{
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "warn",
+      "name": "hello client ts"
+    },
+    "pluginTimeout": 30000
+  },
+  "plugins": {
+    "paths": ["./plugin.ts"],
+    "typescript": true
+  },
+  "clients": [{
+    "schema": "./hello.openapi.json",
+    "name": "hello",
+    "type": "openapi",
+    "url": "{PLT_CLIENT_URL}"
+  }],
+  "metrics": false,
+  "watch": false
+}

package/fixtures/hello-client-ts-without-deps/plugin.ts

@@ -0,0 +1,8 @@
+import { FastifyInstance } from 'fastify'
+/// <reference path="./hello" />
+
+export default async function (app: FastifyInstance) {
+  app.get('/', async () => {
+    return app.hello.get({})
+  })
+}

package/fixtures/hello-client-ts-without-deps/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "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"
+    ]
+  }
+}

package/fixtures/hello-client-without-deps/hello.d.ts

@@ -0,0 +1,34 @@
+import { FastifyPluginAsync } from 'fastify'
+
+interface GetRequest {
+}
+
+interface GetResponse {
+}
+
+interface Hello {
+  get(req: GetRequest): Promise<GetResponse>;
+}
+
+type HelloPlugin = FastifyPluginAsync<NonNullable<hello.HelloOptions>>
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    'hello': Hello;
+  }
+
+  interface FastifyRequest {
+    'hello': Hello;
+  }
+}
+
+declare namespace hello {
+  export interface HelloOptions {
+    url: string
+  }
+  export const hello: HelloPlugin;
+  export { hello as default };
+}
+
+declare function hello(...params: Parameters<HelloPlugin>): ReturnType<HelloPlugin>;
+export = hello;

package/fixtures/hello-client-without-deps/hello.openapi.json

@@ -0,0 +1,22 @@
+{
+  "openapi": "3.0.3",
+  "info": {
+    "title": "Platformatic",
+    "description": "This is a service built on top of Platformatic",
+    "version": "1.0.0"
+  },
+  "components": {
+    "schemas": {}
+  },
+  "paths": {
+    "/": {
+      "get": {
+        "responses": {
+          "200": {
+            "description": "Default Response"
+          }
+        }
+      }
+    }
+  }
+}

package/fixtures/hello-client-without-deps/platformatic.service.json

@@ -0,0 +1,21 @@
+{
+  "server": {
+    "hostname": "127.0.0.1",
+    "port": 0,
+    "logger": {
+      "level": "warn",
+      "name": "hello client"
+    }
+  },
+  "plugins": {
+    "paths": ["./plugin.js"]
+  },
+  "clients": [{
+    "schema": "./hello.openapi.json",
+    "name": "hello",
+    "type": "openapi",
+    "url": "{PLT_CLIENT_URL}"
+  }],
+  "metrics": false,
+  "watch": false
+}

package/fixtures/hello-client-without-deps/plugin.js

@@ -0,0 +1,8 @@
+'use default'
+
+/**  @type {import('fastify').FastifyPluginAsync<{ optionA: boolean, optionB: string }>} */
+module.exports = async function (app) {
+  app.get('/', async () => {
+    return app.hello.get()
+  })
+}

package/help/compile.txt

@@ -1,9 +1,10 @@
 Compile typescript plugins.
+
 ``` bash
   $ platformatic service compile
 ```
 
-As a result of executing this command, the Platformatic DB will compile typescript
+As a result of executing this command, Platformatic Service will compile typescript
 plugins in the `outDir` directory. 
 
 If not specified, the configuration specified will be loaded from

package/index.d.ts

@@ -1,15 +1,21 @@
-import { FastifyInstance } from "fastify"
+/* eslint-disable @typescript-eslint/triple-slash-reference */
+/// <reference types="@platformatic/types" />
+/// <reference types="mercurius" />
+/// <reference types="@fastify/swagger" />
+import { FastifyInstance } from 'fastify'
+import ConfigManager from '@platformatic/config'
 
-export type pltServiceHandlerBuildServer = {
-  app: FastifyInstance
-  address: string
-  port: number
-  restart: () => Promise<void>
-  listen: FastifyInstance['listen']
-  close: FastifyInstance['close']
-  inject: FastifyInstance['inject']
+declare module '@platformatic/types' {
+  interface PlatformaticApp {
+    configManager: ConfigManager
+    config: object
+  }
 }
 
-declare module '@platformatic/service' {
-  export function buildServer(opts: object, app?: object, ConfigManagerContructor?: object): Promise<pltServiceHandlerBuildServer>
+export function buildServer (opts: object, app?: object, ConfigManagerContructor?: object): Promise<FastifyInstance>
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    restart: () => Promise<void>
+  }
 }

package/index.js

@@ -9,7 +9,6 @@ const setupGraphQL = require('./lib/plugins/graphql.js')
 const setupClients = require('./lib/plugins/clients')
 const setupMetrics = require('./lib/plugins/metrics')
 const setupTsCompiler = require('./lib/plugins/typescript')
-const setupFileWatcher = require('./lib/plugins/file-watcher')
 const setupHealthCheck = require('./lib/plugins/health-check')
 const loadPlugins = require('./lib/plugins/plugins')
 
@@ -54,7 +53,10 @@ async function platformaticService (app, opts, toLoad = []) {
   }
 
   if (isKeyEnabled('watch', config)) {
-    await app.register(setupFileWatcher, { onFilesUpdated })
+    // 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) {
@@ -70,25 +72,6 @@ async function platformaticService (app, opts, toLoad = []) {
   }
 }
 
-async function onFilesUpdated (app) {
-  // Reload the config as well, otherwise we will have problems
-  // in case the files watcher triggers the config watcher too
-  const configManager = app.platformatic.configManager
-  try {
-    app.log.debug('files changed')
-    await configManager.parse()
-    await app.restart()
-    /* c8 ignore next 8 */
-  } catch (err) {
-    app.log.error({
-      err: {
-        message: err.message,
-        stack: err.stack
-      }
-    }, 'failed to reload server')
-  }
-}
-
 platformaticService[Symbol.for('skip-override')] = true
 platformaticService.schema = schema
 platformaticService.configType = 'service'

package/index.test-d.ts

@@ -1,24 +1,16 @@
-import { expectError, expectType } from 'tsd';
-import { FastifyInstance } from 'fastify';
-import { pltServiceHandlerBuildServer } from '.';
+import { expectType } from 'tsd'
+import { FastifyInstance } from 'fastify'
+import { buildServer } from '.'
+import ConfigManager from '@platformatic/config'
+import { OpenAPI } from 'openapi-types'
+import type { MercuriusPlugin } from 'mercurius'
 
-const server: pltServiceHandlerBuildServer = {
-  app: {} as FastifyInstance,
-  address: 'localhost',
-  port: 3000,
-  restart: async () => {},
-  listen: async () => '',
-  close: (async () => undefined) as unknown as FastifyInstance['close'],
-  inject: (async () => undefined) as unknown as FastifyInstance['inject']
-};
+const server = await buildServer({
+})
 
-expectType<pltServiceHandlerBuildServer>(server);
-expectError<pltServiceHandlerBuildServer>({...server, app: 'WRONG' });
-expectError<pltServiceHandlerBuildServer>({...server, address: 42 });
-expectError<pltServiceHandlerBuildServer>({...server, port: 'WRONG' });
-expectError<pltServiceHandlerBuildServer>({...server, restart: 'WRONG' });
-expectError<pltServiceHandlerBuildServer>({...server, listen: 'WRONG' });
-expectError<pltServiceHandlerBuildServer>({...server, listen: async () => ({ address: 42, port: 3000 }), });
-expectError<pltServiceHandlerBuildServer>({...server, listen: async () => ({ address: 'localhost', port: 'WRONG' }), });
-expectError<pltServiceHandlerBuildServer>({...server, stop: 'WRONG' });
-expectError<pltServiceHandlerBuildServer>({...server, inject: 'WRONG' });
+expectType<FastifyInstance>(server)
+expectType<ConfigManager>(server.platformatic.configManager)
+expectType<ConfigManager>(server.platformatic.configManager)
+expectType<OpenAPI.Document>(server.swagger())
+expectType<MercuriusPlugin>(server.graphql)
+expectType<Promise<void>>(server.restart())

package/lib/compile.js

@@ -79,31 +79,6 @@ async function compile (cwd, config, originalLogger) {
   }
 }
 
-// This path is tested but C8 does not see it that way given it needs to work
-// through execa.
-/* c8 ignore next 20 */
-async function compileWatch (cwd, config, originalLogger) {
-  const { execa, logger, tscExecutablePath } = await setup(cwd, config, originalLogger)
-  if (!tscExecutablePath) {
-    return false
-  }
-
-  try {
-    await execa(tscExecutablePath, ['--project', 'tsconfig.json', '--incremental', '--rootDir', '.'], { cwd })
-    logger.info('Typescript compilation completed successfully. Starting watch mode.')
-  } catch (error) {
-    throw new Error('Failed to compile typescript files: ' + error)
-  }
-
-  const child = execa(tscExecutablePath, ['--project', 'tsconfig.json', '--watch', '--incremental'], { cwd })
-  child.stdout.resume()
-  child.stderr.on('data', (data) => {
-    logger.error(data.toString())
-  })
-
-  return { child }
-}
-
 function buildCompileCmd (app) {
   return async function compileCmd (_args) {
     let fullPath = null
@@ -126,5 +101,4 @@ function buildCompileCmd (app) {
 }
 
 module.exports.compile = compile
-module.exports.compileWatch = compileWatch
 module.exports.buildCompileCmd = buildCompileCmd

package/lib/load-config.js

@@ -18,8 +18,7 @@ async function loadConfig (minimistConfig, _args, app, overrides = {}) {
   const args = parseArgs(_args, deepmerge({ all: true })({
     string: ['allow-env'],
     default: {
-      allowEnv: '', // The default is set in ConfigManager
-      hotReload: true
+      allowEnv: '' // The default is set in ConfigManager
     },
     alias: {
       v: 'version',

package/lib/plugins/clients.js

@@ -1,11 +1,15 @@
 'use strict'
 
 const fp = require('fastify-plugin')
+const client = require('@platformatic/client')
 
 async function setupClients (app, opts) {
-  const clientsConfig = opts
-  for (const { path, url } of clientsConfig) {
-    app.register(require(path), { url })
+  for (const { path, url, serviceId, name, schema, type } of opts) {
+    if (path) {
+      app.register(require(path), { url, serviceId })
+    } else {
+      app.register(client, { url, serviceId, name, path: schema, type })
+    }
   }
 }
 

package/lib/plugins/plugins.js

@@ -2,8 +2,6 @@
 
 const { join, resolve } = require('path')
 const { readFile } = require('fs/promises')
-
-const sandbox = require('fastify-sandbox')
 const fp = require('fastify-plugin')
 
 const { getJSPluginPath, isFileAccessible } = require('../utils')
@@ -14,43 +12,29 @@ async function loadPlugins (app) {
   const configManager = app.platformatic.configManager
   const config = configManager.current
 
-  if (config.plugins.typescript) {
-    const workingDir = configManager.dirname
-    const tsConfigPath = join(workingDir, 'tsconfig.json')
-
-    const isTsConfigAccessible = await isFileAccessible(tsConfigPath)
-    if (!isTsConfigAccessible) {
-      throw new Error('Cannot load typescript plugin, tsconfig.json not found')
-    }
+  const workingDir = configManager.dirname
+  const tsConfigPath = 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'))
     const outDir = resolve(workingDir, tsConfig.compilerOptions.outDir)
 
-    config.plugins.paths = config.plugins.paths.map((plugin) => {
-      /* c8 ignore next 3 */
-      return typeof plugin === 'string'
-        ? getJSPluginPath(workingDir, plugin, outDir)
-        : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
-    })
-  }
+    const isOutDirAccessible = await isFileAccessible(outDir)
 
-  if (config.plugins.hotReload !== false) {
-    await app.register(sandbox, {
-      path: wrapperPath,
-      options: { paths: config.plugins.paths },
-      customizeGlobalThis (_globalThis) {
-        // Taken from https://github.com/nodejs/undici/blob/fa9fd9066569b6357acacffb806aa804b688c9d8/lib/global.js#L5
-        const globalDispatcher = Symbol.for('undici.globalDispatcher.1')
-        const dispatcher = globalThis[globalDispatcher]
-        /* istanbul ignore else */
-        if (dispatcher) {
-          _globalThis[globalDispatcher] = dispatcher
-        }
-      }
-    })
-  } else {
-    await app.register(require(wrapperPath), { paths: config.plugins.paths })
+    if (isOutDirAccessible) {
+      config.plugins.paths = config.plugins.paths.map((plugin) => {
+        /* c8 ignore next 3 */
+        return typeof plugin === 'string'
+          ? getJSPluginPath(workingDir, plugin, outDir)
+          : { ...plugin, path: getJSPluginPath(workingDir, plugin.path, outDir) }
+      })
+    }
   }
+
+  await app.register(require(wrapperPath), { paths: config.plugins.paths })
 }
 
 module.exports = fp(loadPlugins)

package/lib/plugins/typescript.js

@@ -1,8 +1,6 @@
 'use strict'
 
-const { isKeyEnabled } = require('@platformatic/utils')
 const fp = require('fastify-plugin')
-
 const compiler = require('../compile')
 
 async function setupTsCompiler (app) {
@@ -10,37 +8,9 @@ async function setupTsCompiler (app) {
 
   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
-
   const workingDir = configManager.dirname
 
-  if (isKeyEnabled('watch', config)) {
-    let tsCompilerWatcher = persistentRef.tsCompilerWatcher
-    if (!tsCompilerWatcher) {
-      /* c8 ignore next 5 */
-      const { child } = await compiler.compileWatch(workingDir, config, app.log)
-      app.log.debug('start watching typescript files')
-      tsCompilerWatcher = child
-    }
-    app.decorate('tsCompilerWatcher', tsCompilerWatcher)
-  } else {
-    await compiler.compile(workingDir, config, app.log)
-  }
-
-  app.addHook('onClose', async () => {
-    if (!isRestartableApp || app.closingRestartable) {
-      /* c8 ignore next 4 */
-      if (app.tsCompilerWatcher) {
-        app.tsCompilerWatcher.kill('SIGTERM')
-        app.log.debug('stop watching typescript files')
-      }
-    }
-  })
+  await compiler.compile(workingDir, config, app.log)
 }
 
 module.exports = fp(setupTsCompiler)