@platformatic/runtime 3.4.1 → 3.5.0

package/lib/errors.js

@@ -1,37 +1,129 @@
-'use strict'
+import createError from '@fastify/error'
 
-const createError = require('@fastify/error')
+export const ERROR_PREFIX = 'PLT_RUNTIME'
 
-const ERROR_PREFIX = 'PLT_RUNTIME'
+export const AddressInUseError = createError(
+  `${ERROR_PREFIX}_EADDR_IN_USE`,
+  'The current port is in use by another application'
+)
+export const RuntimeExitedError = createError(
+  `${ERROR_PREFIX}_RUNTIME_EXIT`,
+  'The runtime exited before the operation completed'
+)
+export const RuntimeAbortedError = createError(`${ERROR_PREFIX}_RUNTIME_ABORT`, 'The runtime aborted the operation')
+// The following two use the same code as we only need to differentiate the label
+export const ApplicationExitedError = createError(
+  `${ERROR_PREFIX}_APPLICATION_EXIT`,
+  'The application "%s" exited prematurely with error code %d'
+)
+export const WorkerExitedError = createError(
+  `${ERROR_PREFIX}_APPLICATION_WORKER_EXIT`,
+  'The worker %s of the application "%s" exited prematurely with error code %d'
+)
+export const UnknownRuntimeAPICommandError = createError(
+  `${ERROR_PREFIX}_UNKNOWN_RUNTIME_API_COMMAND`,
+  'Unknown Runtime API command "%s"'
+)
+export const ApplicationNotFoundError = createError(
+  `${ERROR_PREFIX}_APPLICATION_NOT_FOUND`,
+  'Application %s not found. Available applications are: %s'
+)
+export const WorkerNotFoundError = createError(
+  `${ERROR_PREFIX}_WORKER_NOT_FOUND`,
+  'Worker %s of application %s not found. Available applications are: %s'
+)
+export const ApplicationNotStartedError = createError(
+  `${ERROR_PREFIX}_APPLICATION_NOT_STARTED`,
+  "Application with id '%s' is not started"
+)
+export const ApplicationStartTimeoutError = createError(
+  `${ERROR_PREFIX}_APPLICATION_START_TIMEOUT`,
+  "Application with id '%s' failed to start in %dms."
+)
+export const FailedToRetrieveOpenAPISchemaError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_OPENAPI_SCHEMA`,
+  'Failed to retrieve OpenAPI schema for application with id "%s": %s'
+)
+export const FailedToRetrieveGraphQLSchemaError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_GRAPHQL_SCHEMA`,
+  'Failed to retrieve GraphQL schema for application with id "%s": %s'
+)
+export const FailedToRetrieveMetaError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_META`,
+  'Failed to retrieve metadata for application with id "%s": %s'
+)
+export const FailedToRetrieveMetricsError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_METRICS`,
+  'Failed to retrieve metrics for application with id "%s": %s'
+)
+export const FailedToRetrieveHealthError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_RETRIEVE_HEALTH`,
+  'Failed to retrieve health for application with id "%s": %s'
+)
+export const FailedToPerformCustomHealthCheckError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_PERFORM_CUSTOM_HEALTH_CHECK`,
+  'Failed to perform custom healthcheck for application with id "%s": %s'
+)
+export const FailedToPerformCustomReadinessCheckError = createError(
+  `${ERROR_PREFIX}_FAILED_TO_PERFORM_CUSTOM_READINESS_CHECK`,
+  'Failed to perform custom readiness check for application with id "%s": %s'
+)
+export const ApplicationAlreadyStartedError = createError(
+  `${ERROR_PREFIX}_APPLICATION_ALREADY_STARTED`,
+  'Application is already started'
+)
+export const RuntimeNotStartedError = createError(`${ERROR_PREFIX}_NOT_STARTED`, 'Application has not been started')
+export const ConfigPathMustBeStringError = createError(
+  `${ERROR_PREFIX}_CONFIG_PATH_MUST_BE_STRING`,
+  'Config path must be a string'
+)
+export const NoConfigFileFoundError = createError(
+  `${ERROR_PREFIX}_NO_CONFIG_FILE_FOUND`,
+  "No config file found for application '%s'"
+)
+export const InvalidEntrypointError = createError(
+  `${ERROR_PREFIX}_INVALID_ENTRYPOINT`,
+  "Invalid entrypoint: '%s' does not exist"
+)
+export const MissingEntrypointError = createError(
+  `${ERROR_PREFIX}_MISSING_ENTRYPOINT`,
+  'Missing application entrypoint.'
+)
+export const MissingDependencyError = createError(`${ERROR_PREFIX}_MISSING_DEPENDENCY`, 'Missing dependency: "%s"')
+export const InspectAndInspectBrkError = createError(
+  `${ERROR_PREFIX}_INSPECT_AND_INSPECT_BRK`,
+  '--inspect and --inspect-brk cannot be used together'
+)
+export const InspectorPortError = createError(
+  `${ERROR_PREFIX}_INSPECTOR_PORT`,
+  'Inspector port must be 0 or in range 1024 to 65535'
+)
+export const InspectorHostError = createError(`${ERROR_PREFIX}_INSPECTOR_HOST`, 'Inspector host cannot be empty')
+export const CannotMapSpecifierToAbsolutePathError = createError(
+  `${ERROR_PREFIX}_CANNOT_MAP_SPECIFIER_TO_ABSOLUTE_PATH`,
+  'Cannot map "%s" to an absolute path'
+)
+export const NodeInspectorFlagsNotSupportedError = createError(
+  `${ERROR_PREFIX}_NODE_INSPECTOR_FLAGS_NOT_SUPPORTED`,
+  "The Node.js inspector flags are not supported. Please use 'platformatic start --inspect' instead."
+)
+export const FailedToUnlinkManagementApiSocket = createError(
+  `${ERROR_PREFIX}_FAILED_TO_UNLINK_MANAGEMENT_API_SOCKET`,
+  'Failed to unlink management API socket "%s"'
+)
+export const LogFileNotFound = createError(
+  `${ERROR_PREFIX}_LOG_FILE_NOT_FOUND`,
+  'Log file with index %s not found',
+  404
+)
+export const WorkerIsRequired = createError(`${ERROR_PREFIX}_REQUIRED_WORKER`, 'The worker parameter is required')
+export const InvalidArgumentError = createError(`${ERROR_PREFIX}_INVALID_ARGUMENT`, 'Invalid argument: "%s"')
+export const MessagingError = createError(
+  `${ERROR_PREFIX}_MESSAGING_ERROR`,
+  'Cannot send a message to application "%s": %s'
+)
 
-module.exports = {
-  AddressInUseError: createError(`${ERROR_PREFIX}_EADDR_IN_USE`, 'The current port is in use by another application'),
-  RuntimeExitedError: createError(`${ERROR_PREFIX}_RUNTIME_EXIT`, 'The runtime exited before the operation completed'),
-  ServiceExitedError: createError(`${ERROR_PREFIX}_SERVICE_EXIT`, 'The service %s exited prematurely with error code %d'),
-  UnknownRuntimeAPICommandError: createError(`${ERROR_PREFIX}_UNKNOWN_RUNTIME_API_COMMAND`, 'Unknown Runtime API command "%s"'),
-  ServiceNotFoundError: createError(`${ERROR_PREFIX}_SERVICE_NOT_FOUND`, 'Service %s not found. Available services are: %s'),
-  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'),
-  FailedToRetrieveGraphQLSchemaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_GRAPHQL_SCHEMA`, 'Failed to retrieve GraphQL schema for service with id "%s": %s'),
-  FailedToRetrieveMetaError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_META`, 'Failed to retrieve metadata for service with id "%s": %s'),
-  FailedToRetrieveMetricsError: createError(`${ERROR_PREFIX}_FAILED_TO_RETRIEVE_METRICS`, 'Failed to retrieve metrics 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"),
-  MissingEntrypointError: createError(`${ERROR_PREFIX}_MISSING_ENTRYPOINT`, 'Missing application entrypoint.'),
-  InvalidServicesWithWebError: createError(`${ERROR_PREFIX}_INVALID_SERVICES_WITH_WEB`, 'The "services" property cannot be used when the "web" property is also defined'),
-  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.'),
-  FailedToUnlinkManagementApiSocket: createError(`${ERROR_PREFIX}_FAILED_TO_UNLINK_MANAGEMENT_API_SOCKET`, 'Failed to unlink management API socket "%s"'),
-  LogFileNotFound: createError(`${ERROR_PREFIX}_LOG_FILE_NOT_FOUND`, 'Log file with index %s not found', 404),
-  WorkerIsRequired: createError(`${ERROR_PREFIX}_REQUIRED_WORKER`, 'The worker parameter is required'),
-
-  // TODO: should remove next one as it's not used anymore
-  CannotRemoveServiceOnUpdateError: createError(`${ERROR_PREFIX}_CANNOT_REMOVE_SERVICE_ON_UPDATE`, 'Cannot remove service "%s" when updating a Runtime'),
-}
+export const MissingPprofCapture = createError(
+  `${ERROR_PREFIX}_MISSING_PPROF_CAPTURE`,
+  'Please install @platformatic/wattpm-pprof-capture'
+)