@platformatic/runtime 0.45.0 → 0.46.1

package/index.d.ts

@@ -1,4 +1,5 @@
 import { InjectOptions, LightMyRequestResponse } from 'fastify'
+import { FastifyError } from '@fastify/error'
 
 export type pltRuntimeBuildServer = {
   address: string
@@ -11,3 +12,26 @@ export type pltRuntimeBuildServer = {
 declare module '@platformatic/runtime' {
   export function buildServer(opts: object): Promise<pltRuntimeBuildServer>
 }
+
+/**
+ * All the errors thrown by the plugin.
+ */
+export module errors {
+  export const RuntimeExitedError: () => FastifyError
+  export const UnknownRuntimeAPICommandError: (command: string) => FastifyError
+  export const ServiceNotFoundError: (id: string) => FastifyError
+  export const ServiceNotStartedError: (id: string) => FastifyError
+  export const FailedToRetrieveOpenAPISchemaError: (id: string, error: string) => FastifyError
+  export const ApplicationAlreadyStartedError: () => FastifyError
+  export const ApplicationNotStartedError: () => FastifyError
+  export const ConfigPathMustBeStringError: () => FastifyError
+  export const NoConfigFileFoundError: (id: string) => FastifyError
+  export const InvalidEntrypointError: (entrypoint: string) => FastifyError
+  export const MissingDependencyError: (dependency: string) => FastifyError
+  export const InspectAndInspectBrkError: () => FastifyError
+  export const InspectorPortError: () => FastifyError
+  export const InspectorHostError: () => FastifyError
+  export const CannotMapSpecifierToAbsolutePathError: (specifier: string) => FastifyError
+  export const NodeInspectorFlagsNotSupportedError: () => FastifyError
+}
+

package/index.js

@@ -5,6 +5,7 @@ const { start, startCommand } = require('./lib/start')
 const RuntimeApi = require('./lib/api')
 const { compile } = require('./lib/compile')
 const { loadConfig } = require('./lib/load-config')
+const errors = require('./lib/errors')
 
 module.exports.buildServer = buildServer
 module.exports.platformaticRuntime = platformaticRuntime
@@ -14,3 +15,4 @@ module.exports.start = start
 module.exports.startCommand = startCommand
 module.exports.compile = compile
 module.exports.loadConfig = loadConfig
+module.exports.errors = errors

package/index.test-d.ts

@@ -1,18 +1,43 @@
 import { expectError, expectType } from 'tsd';
 import { LightMyRequestResponse } from 'fastify';
-import { pltRuntimeBuildServer } from '.';
+import { pltRuntimeBuildServer, errors } from '.';
+import { FastifyError } from '@fastify/error'
 
 const server: pltRuntimeBuildServer = {
   address: 'localhost',
   port: 3000,
-  restart: async () => {},
-  stop: async () => {},
+  restart: async () => { },
+  stop: async () => { },
   inject: async () => ({} as LightMyRequestResponse),
 };
 
 expectType<pltRuntimeBuildServer>(server);
-expectError<pltRuntimeBuildServer>({...server, address: 42 });
-expectError<pltRuntimeBuildServer>({...server, port: 'WRONG' });
-expectError<pltRuntimeBuildServer>({...server, restart: 'WRONG' });
-expectError<pltRuntimeBuildServer>({...server, stop: 'WRONG' });
-expectError<pltRuntimeBuildServer>({...server, inject: 'WRONG' });
+expectError<pltRuntimeBuildServer>({ ...server, address: 42 });
+expectError<pltRuntimeBuildServer>({ ...server, port: 'WRONG' });
+expectError<pltRuntimeBuildServer>({ ...server, restart: 'WRONG' });
+expectError<pltRuntimeBuildServer>({ ...server, stop: 'WRONG' });
+expectError<pltRuntimeBuildServer>({ ...server, inject: 'WRONG' });
+
+// Errors
+type ErrorWithNoParams = () => FastifyError
+type ErrorWithOneParam = (param: string) => FastifyError
+type ErrorWithOneAnyParam = (param: string) => FastifyError
+type ErrorWithTwoParams = (param1: string, param2: string) => FastifyError
+
+expectType<ErrorWithNoParams>(errors.RuntimeExitedError)
+expectType<ErrorWithOneParam>(errors.UnknownRuntimeAPICommandError)
+expectType<ErrorWithOneParam>(errors.ServiceNotFoundError)
+expectType<ErrorWithOneParam>(errors.ServiceNotStartedError)
+expectType<ErrorWithTwoParams>(errors.FailedToRetrieveOpenAPISchemaError)
+expectType<ErrorWithNoParams>(errors.ApplicationAlreadyStartedError)
+expectType<ErrorWithNoParams>(errors.ApplicationNotStartedError)
+expectType<ErrorWithNoParams>(errors.ConfigPathMustBeStringError)
+expectType<ErrorWithOneParam>(errors.NoConfigFileFoundError)
+expectType<ErrorWithOneParam>(errors.InvalidEntrypointError)
+expectType<ErrorWithOneParam>(errors.MissingDependencyError)
+expectType<ErrorWithNoParams>(errors.InspectAndInspectBrkError)
+expectType<ErrorWithNoParams>(errors.InspectorPortError)
+expectType<ErrorWithNoParams>(errors.InspectorHostError)
+expectType<ErrorWithOneParam>(errors.CannotMapSpecifierToAbsolutePathError)
+expectType<ErrorWithNoParams>(errors.NodeInspectorFlagsNotSupportedError)
+

package/lib/api-client.js

@@ -2,6 +2,7 @@
 
 const { once, EventEmitter } = require('node:events')
 const { randomUUID } = require('node:crypto')
+const errors = require('./errors')
 
 const MAX_LISTENERS_COUNT = 100
 
@@ -72,7 +73,7 @@ class RuntimeApiClient extends EventEmitter {
     )
 
     if (this.#exitCode !== undefined) {
-      throw new Error('The runtime exited before the operation completed')
+      throw new errors.RuntimeExitedError()
     }
 
     const { error, data } = message

package/lib/api.js

@@ -3,6 +3,7 @@
 const FastifyUndiciDispatcher = require('fastify-undici-dispatcher')
 const { Agent, setGlobalDispatcher } = require('undici')
 const { PlatformaticApp } = require('./app')
+const errors = require('./errors')
 
 class RuntimeApi {
   #services
@@ -96,7 +97,7 @@ class RuntimeApi {
         return this.#inject(params)
       /* c8 ignore next 2 */
       default:
-        throw new Error(`Unknown Runtime API command: '${command}'`)
+        throw new errors.UnknownRuntimeAPICommandError(command)
     }
   }
 
@@ -160,7 +161,7 @@ class RuntimeApi {
     const service = this.#services.get(id)
 
     if (!service) {
-      throw new Error(`Service with id '${id}' not found`)
+      throw new errors.ServiceNotFoundError(id)
     }
 
     return service
@@ -179,7 +180,7 @@ class RuntimeApi {
 
     const { config } = service
     if (!config) {
-      throw new Error(`Service with id '${id}' is not started`)
+      throw new errors.ServiceNotStartedError(id)
     }
 
     return config.configManager.current
@@ -189,7 +190,7 @@ class RuntimeApi {
     const service = this.#getServiceById(id)
 
     if (!service.config) {
-      throw new Error(`Service with id '${id}' is not started`)
+      throw new errors.ServiceNotStartedError(id)
     }
 
     if (typeof service.server.swagger !== 'function') {
@@ -201,7 +202,7 @@ class RuntimeApi {
       const openapiSchema = service.server.swagger()
       return openapiSchema
     } catch (err) {
-      throw new Error(`Failed to retrieve OpenAPI schema for service with id '${id}': ${err.message}`)
+      throw new errors.FailedToRetrieveOpenAPISchemaError(id, err.message)
     }
   }
 
@@ -220,7 +221,7 @@ class RuntimeApi {
 
     const serviceStatus = service.getStatus()
     if (serviceStatus !== 'started') {
-      throw new Error(`Service with id '${id}' is not started`)
+      throw new errors.ServiceNotStartedError(id)
     }
 
     const res = await service.server.inject(injectParams)

package/lib/app.js

@@ -6,6 +6,7 @@ const { FileWatcher } = require('@platformatic/utils')
 const debounce = require('debounce')
 const { buildServer } = require('./build-server')
 const { loadConfig } = require('./load-config')
+const errors = require('./errors')
 
 class PlatformaticApp {
   #hotReload
@@ -78,7 +79,7 @@ class PlatformaticApp {
 
   async start () {
     if (this.#started) {
-      throw new Error('application is already started')
+      throw new errors.ApplicationAlreadyStartedError()
     }
 
     this.#started = true
@@ -131,7 +132,7 @@ class PlatformaticApp {
 
   async stop () {
     if (!this.#started) {
-      throw new Error('application has not been started')
+      throw new errors.ApplicationNotStartedError()
     }
 
     await this.#stopFileWatching()
@@ -190,7 +191,7 @@ class PlatformaticApp {
       if (appConfig._configOverrides instanceof Map) {
         appConfig._configOverrides.forEach((value, key) => {
           if (typeof key !== 'string') {
-            throw new Error('config path must be a string.')
+            throw new errors.ConfigPathMustBeStringError()
           }
 
           const parts = key.split('.')

package/lib/config.js

@@ -5,6 +5,7 @@ const { closest } = require('fastest-levenshtein')
 const Topo = require('@hapi/topo')
 const ConfigManager = require('@platformatic/config')
 const { schema } = require('./schema')
+const errors = require('./errors')
 
 async function _transformConfig (configManager) {
   const config = configManager.current
@@ -27,7 +28,7 @@ async function _transformConfig (configManager) {
       const configFilename = mapping.config ?? await ConfigManager.findConfigFile(entryPath)
 
       if (typeof configFilename !== 'string') {
-        throw new Error(`no config file found for service '${id}'`)
+        throw new errors.NoConfigFileFoundError(id)
       }
 
       const config = join(entryPath, configFilename)
@@ -61,7 +62,7 @@ async function _transformConfig (configManager) {
   }
 
   if (!hasValidEntrypoint) {
-    throw new Error(`invalid entrypoint: '${config.entrypoint}' does not exist`)
+    throw new errors.InvalidEntrypointError(config.entrypoint)
   }
 
   configManager.current.services = services
@@ -104,6 +105,8 @@ async function parseClientsAndComposer (configManager) {
             isLocal = false
             /* c8 ignore next 4 */
           } catch (err) {
+            // The MissingValueError is an error coming from pupa: https://github.com/sindresorhus/pupa#missingvalueerror
+            // All other errors are simply rethrown.
             if (err.name !== 'MissingValueError') {
               throw err
             }
@@ -117,7 +120,7 @@ async function parseClientsAndComposer (configManager) {
 
         if (isLocal) {
           if (dependency === undefined) {
-            throw new Error(missingDependencyErrorMessage(clientName, service, configManager))
+            throw new errors.MissingDependencyError(missingDependencyErrorMessage(clientName, service, configManager))
           }
           clientUrl = `http://${clientName}.plt.local`
           dependency.dependents.push(service.id)
@@ -195,8 +198,7 @@ async function parseClientsAndComposer (configManager) {
 
           /* c8 ignore next 4 */
           if (dependency === undefined) {
-            reject(new Error(missingDependencyErrorMessage(clientName, service, configManager)))
-            return
+            throw new errors.MissingDependencyError(missingDependencyErrorMessage(clientName, service, configManager))
           }
 
           dependency.dependents.push(service.id)
@@ -291,7 +293,7 @@ function parseInspectorOptions (configManager) {
     inspectFlag = args.inspect
 
     if (hasInspectBrk) {
-      throw new Error('--inspect and --inspect-brk cannot be used together')
+      throw new errors.InspectAndInspectBrkError()
     }
   } else if (hasInspectBrk) {
     inspectFlag = args['inspect-brk']
@@ -314,11 +316,11 @@ function parseInspectorOptions (configManager) {
       port = Number.parseInt(port, 10)
 
       if (!(port === 0 || (port >= 1024 && port <= 65535))) {
-        throw new Error('inspector port must be 0 or in range 1024 to 65535')
+        throw new errors.InspectorPortError()
       }
 
       if (!host) {
-        throw new Error('inspector host cannot be empty')
+        throw new errors.InspectorHostError()
       }
     }
 

package/lib/errors.js

@@ -0,0 +1,25 @@
+'use strict'
+
+const createError = require('@fastify/error')
+
+const ERROR_PREFIX = 'PLT_SQL_RUNTIME'
+
+module.exports = {
+  RuntimeExitedError: createError(`${ERROR_PREFIX}_RUNTIME_EXIT`, 'The runtime exited before the operation completed'),
+  UnknownRuntimeAPICommandError: createError(`${ERROR_PREFIX}_UNKNOWN_RUNTIME_API_COMMAND`, 'Unknown Runtime API command "%s"'),
+  ServiceNotFoundError: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, "Service with id '%s' not found"),
+  ServiceNotStartedError: createError(`${ERROR_PREFIX}_SERVICE_NOT_STARTED`, "Service with id '%s' is not started"),
+  FailedToRetrieveOpenAPISchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_OPENAPI_SCHEMA`, 'Failed to retrieve OpenAPI schema for service with id "%s": %s'),
+  ApplicationAlreadyStartedError: createError(`${ERROR_PREFIX}_APPLICATION_ALREADY_STARTED`, 'Application is already started'),
+  ApplicationNotStartedError: createError(`${ERROR_PREFIX}_APPLICATION_NOT_STARTED`, 'Application has not been started'),
+  ConfigPathMustBeStringError: createError(`${ERROR_PREFIX}_CONFIG_PATH_MUST_BE_STRING`, 'Config path must be a string'),
+  NoConfigFileFoundError: createError(`${ERROR_PREFIX}_NO_CONFIG_FILE_FOUND`, "No config file found for service '%s'"),
+  InvalidEntrypointError: createError(`${ERROR_PREFIX}_INVALID_ENTRYPOINT`, "Invalid entrypoint: '%s' does not exist"),
+  MissingDependencyError: createError(`${ERROR_PREFIX}_MISSING_DEPENDENCY`, 'Missing dependency: "%s"'),
+  InspectAndInspectBrkError: createError(`${ERROR_PREFIX}_INSPECT_AND_INSPECT_BRK`, '--inspect and --inspect-brk cannot be used together'),
+  InspectorPortError: createError(`${ERROR_PREFIX}_INSPECTOR_PORT`, 'Inspector port must be 0 or in range 1024 to 65535'),
+  InspectorHostError: createError(`${ERROR_PREFIX}_INSPECTOR_HOST`, 'Inspector host cannot be empty'),
+  CannotMapSpecifierToAbsolutePathError: createError(`${ERROR_PREFIX}_CANNOT_MAP_SPECIFIER_TO_ABSOLUTE_PATH`, 'Cannot map "%s" to an absolute path'),
+  NodeInspectorFlagsNotSupportedError: createError(`${ERROR_PREFIX}_NODE_INSPECTOR_FLAGS_NOT_SUPPORTED`, 'The Node.js inspector flags are not supported. Please use \'platformatic start --inspect\' instead.')
+
+}

package/lib/loader.mjs

@@ -1,6 +1,7 @@
 import { createRequire, isBuiltin } from 'node:module'
 import { dirname, isAbsolute, resolve as pathResolve } from 'node:path'
 import { fileURLToPath, pathToFileURL } from 'node:url'
+import errors from './errors.js'
 const isWindows = process.platform === 'win32'
 let timestamp = process.hrtime.bigint()
 let port
@@ -54,7 +55,7 @@ function specifierToFileUrl (specifier, referencingModuleId) {
 
   /* c8 ignore next 3 */
   if (!referencingModuleId) {
-    throw new Error(`cannot map '${specifier}' to an absolute path`)
+    throw new errors.CannotMapSpecifierToAbsolutePathError(specifier)
   }
 
   /* c8 ignore next 5 - c8 upgrade marked many existing things as uncovered */

package/lib/start.js

@@ -10,6 +10,7 @@ const { loadConfig } = require('./load-config')
 const { parseInspectorOptions, wrapConfigInRuntimeConfig } = require('./config')
 const RuntimeApiClient = require('./api-client.js')
 const { printConfigValidationErrors } = require('@platformatic/config')
+const errors = require('./errors')
 
 const kLoaderFile = pathToFileURL(join(__dirname, 'loader.mjs')).href
 const kWorkerFile = join(__dirname, 'worker.js')
@@ -23,7 +24,7 @@ async function startWithConfig (configManager, env = process.env) {
   const config = configManager.current
 
   if (inspector.url()) {
-    throw new Error('The Node.js inspector flags are not supported. Please use \'platformatic start --inspect\' instead.')
+    throw new errors.NodeInspectorFlagsNotSupportedError()
   }
 
   if (configManager.args) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/runtime",
-  "version": "0.45.0",
+  "version": "0.46.1",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -24,11 +24,12 @@
     "standard": "^17.1.0",
     "tsd": "^0.29.0",
     "typescript": "^5.1.6",
-    "@platformatic/sql-graphql": "0.45.0",
-    "@platformatic/sql-mapper": "0.45.0"
+    "@platformatic/sql-graphql": "0.46.1",
+    "@platformatic/sql-mapper": "0.46.1"
   },
   "dependencies": {
     "@hapi/topo": "^6.0.2",
+    "@fastify/error": "^3.2.1",
     "close-with-grace": "^1.2.0",
     "commist": "^3.2.0",
     "debounce": "^1.2.1",
@@ -42,12 +43,12 @@
     "pino": "^8.14.1",
     "pino-pretty": "^10.0.0",
     "undici": "^5.22.1",
-    "@platformatic/composer": "0.45.0",
-    "@platformatic/config": "0.45.0",
-    "@platformatic/db": "0.45.0",
-    "@platformatic/service": "0.45.0",
-    "@platformatic/telemetry": "0.45.0",
-    "@platformatic/utils": "0.45.0"
+    "@platformatic/composer": "0.46.1",
+    "@platformatic/config": "0.46.1",
+    "@platformatic/db": "0.46.1",
+    "@platformatic/service": "0.46.1",
+    "@platformatic/telemetry": "0.46.1",
+    "@platformatic/utils": "0.46.1"
   },
   "standard": {
     "ignore": [

package/test/api.test.js

@@ -230,7 +230,7 @@ test('should fail to start running service', async (t) => {
     await app.startService('with-logger')
     assert.fail('should have thrown')
   } catch (err) {
-    assert.strictEqual(err.message, 'application is already started')
+    assert.strictEqual(err.message, 'Application is already started')
   }
 })
 

package/test/app.test.js

@@ -65,7 +65,7 @@ test('errors when starting an already started application', async (t) => {
   await app.start()
   await assert.rejects(async () => {
     await app.start()
-  }, /application is already started/)
+  }, /Application is already started/)
 })
 
 test('errors when stopping an already stopped application', async (t) => {
@@ -86,7 +86,7 @@ test('errors when stopping an already stopped application', async (t) => {
 
   await assert.rejects(async () => {
     await app.stop()
-  }, /application has not been started/)
+  }, /Application has not been started/)
 })
 
 test('does not restart while restarting', async (t) => {
@@ -244,7 +244,7 @@ test('supports configuration overrides', async (t) => {
 
     await assert.rejects(async () => {
       await app.start()
-    }, /config path must be a string/)
+    }, /Config path must be a string/)
   })
 
   await t.test('ignores invalid config paths', async (t) => {

package/test/config.test.js

@@ -15,7 +15,7 @@ test('throws if no entrypoint is found', async (t) => {
 
   await assert.rejects(async () => {
     await loadConfig({}, ['-c', configFile], platformaticRuntime)
-  }, /invalid entrypoint: 'invalid' does not exist/)
+  }, /Invalid entrypoint: 'invalid' does not exist/)
 })
 
 test('throws if a config file is not found for an individual service', async (t) => {
@@ -23,7 +23,7 @@ test('throws if a config file is not found for an individual service', async (t)
 
   await assert.rejects(async () => {
     await loadConfig({}, ['-c', configFile], platformaticRuntime)
-  }, /no config file found for service 'docs'/)
+  }, /No config file found for service 'docs'/)
 })
 
 test('performs a topological sort on services depending on allowCycles', async (t) => {
@@ -173,7 +173,7 @@ test('parseInspectorOptions()', async (t) => {
       }
 
       parseInspectorOptions(cm)
-    }, /inspector host cannot be empty/)
+    }, /Inspector host cannot be empty/)
   })
 
   await t.test('differentiates valid and invalid ports', () => {
@@ -185,7 +185,7 @@ test('parseInspectorOptions()', async (t) => {
         }
 
         parseInspectorOptions(cm)
-      }, /inspector port must be 0 or in range 1024 to 65535/)
+      }, /Inspector port must be 0 or in range 1024 to 65535/)
     })
 
     const cm = {