@platformatic/service 3.0.0-alpha.5 → 3.0.0-alpha.8

package/LICENSE

@@ -136,7 +136,7 @@
       with Licensor regarding such Contributions.
 
    6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
+      names, trademarks, application marks, or product names of the Licensor,
       except as required for reasonable and customary use in describing the
       origin of the Work and reproducing the content of the NOTICE file.
 

package/config.d.ts

@@ -167,11 +167,11 @@ export interface PlatformaticServiceConfig {
   telemetry?: {
     enabled?: boolean | string;
     /**
-     * The name of the service. Defaults to the folder name if not specified.
+     * The name of the application. Defaults to the folder name if not specified.
      */
-    serviceName: string;
+    applicationName: string;
     /**
-     * The version of the service (optional)
+     * The version of the application (optional)
      */
     version?: string;
     /**
@@ -310,6 +310,9 @@ export interface PlatformaticServiceConfig {
   runtime?: {
     preload?: string | string[];
     basePath?: string;
+    services?: {
+      [k: string]: unknown;
+    }[];
     workers?: number | string;
     logger?: {
       level: (
@@ -397,7 +400,7 @@ export interface PlatformaticServiceConfig {
     restartOnError?: boolean | number;
     gracefulShutdown?: {
       runtime: number | string;
-      service: number | string;
+      application: number | string;
     };
     health?: {
       enabled?: boolean | string;
@@ -516,11 +519,11 @@ export interface PlatformaticServiceConfig {
     telemetry?: {
       enabled?: boolean | string;
       /**
-       * The name of the service. Defaults to the folder name if not specified.
+       * The name of the application. Defaults to the folder name if not specified.
        */
-      serviceName: string;
+      applicationName: string;
       /**
-       * The version of the service (optional)
+       * The version of the application (optional)
        */
       version?: string;
       /**
@@ -596,7 +599,7 @@ export interface PlatformaticServiceConfig {
       watchDisabled?: boolean;
       [k: string]: unknown;
     };
-    serviceTimeout?: number | string;
+    applicationTimeout?: number | string;
     messagingTimeout?: number | string;
     env?: {
       [k: string]: string;

package/index.d.ts

@@ -1,4 +1,4 @@
-import { BaseContext, BaseOptions, BaseStackable } from '@platformatic/basic'
+import { BaseCapability, BaseContext, BaseOptions } from '@platformatic/basic'
 import { Configuration, ConfigurationOptions } from '@platformatic/foundation'
 import { BaseGenerator } from '@platformatic/generators'
 import { JSONSchemaType } from 'ajv'
@@ -34,11 +34,11 @@ export declare function create (
   root: string | PlatformaticServiceConfig,
   source?: string | PlatformaticServiceConfig,
   context?: ConfigurationOptions
-): Promise<ServiceStackable>
+): Promise<ServiceCapability>
 
 export declare const skipTelemetryHooks: boolean
 
-export declare function platformaticService (app: FastifyInstance, stackable: ServiceStackable): Promise<void>
+export declare function platformaticService (app: FastifyInstance, capability: ServiceCapability): Promise<void>
 
 export declare class Generator extends BaseGenerator.BaseGenerator {}
 export declare function applyTestHelperCustomizations (
@@ -59,12 +59,12 @@ export declare const schemaComponents: {
   proxy: JSONSchemaType<object>
   graphqlBase: JSONSchemaType<object>
   graphql: JSONSchemaType<object>
-  service: JSONSchemaType<object>
+  application: JSONSchemaType<object>
 }
 
 export declare const version: string
 
-export declare class ServiceStackable<Config = PlatformaticServiceConfig> extends BaseStackable<
+export declare class ServiceCapability<Config = PlatformaticServiceConfig> extends BaseCapability<
   Config,
   BaseOptions<ServiceContext>
 > {

package/index.js

@@ -2,8 +2,8 @@ import { transform as basicTransform, resolve, validationOptions } from '@platfo
 import { kMetadata, loadConfiguration as utilsLoadConfiguration } from '@platformatic/foundation'
 import { readFile } from 'node:fs/promises'
 import { join } from 'node:path'
+import { ServiceCapability } from './lib/capability.js'
 import { schema } from './lib/schema.js'
-import { ServiceStackable } from './lib/stackable.js'
 import { upgrade } from './lib/upgrade.js'
 import { isDocker } from './lib/utils.js'
 
@@ -52,12 +52,12 @@ export async function loadConfiguration (configOrRoot, sourceOrConfig, context)
 
 export async function create (configOrRoot, sourceOrConfig, context) {
   const config = await loadConfiguration(configOrRoot, sourceOrConfig, context)
-  return new ServiceStackable(config[kMetadata].root, config, context)
+  return new ServiceCapability(config[kMetadata].root, config, context)
 }
 
 export const skipTelemetryHooks = true
 
 export { platformaticService } from './lib/application.js'
+export { ServiceCapability } from './lib/capability.js'
 export { applyTestHelperCustomizations, Generator } from './lib/generator.js'
 export { packageJson, schema, schemaComponents, version } from './lib/schema.js'
-export { ServiceStackable } from './lib/stackable.js'

package/lib/application.js

@@ -5,8 +5,8 @@ import { setupHealthCheck } from './plugins/health-check.js'
 import { setupOpenAPI } from './plugins/openapi.js'
 import { loadPlugins } from './plugins/plugins.js'
 
-export async function platformaticService (app, stackable) {
-  const config = await stackable.getConfig()
+export async function platformaticService (app, capability) {
+  const config = await capability.getConfig()
 
   const serviceConfig = config.service || {}
 
@@ -20,7 +20,7 @@ export async function platformaticService (app, stackable) {
   }
 
   if (config.plugins) {
-    await app.register(loadPlugins, stackable.context)
+    await app.register(loadPlugins, capability.context)
   }
 
   if (isKeyEnabled('cors', config.server)) {

package/lib/{stackable.js → capability.js}

@@ -1,4 +1,4 @@
-import { BaseStackable, cleanBasePath, ensureTrailingSlash, getServerUrl } from '@platformatic/basic'
+import { BaseCapability, cleanBasePath, ensureTrailingSlash, getServerUrl } from '@platformatic/basic'
 import { buildPinoFormatters, buildPinoTimestamp, deepmerge, features, isKeyEnabled } from '@platformatic/foundation'
 import { telemetry } from '@platformatic/telemetry'
 import fastify from 'fastify'
@@ -11,7 +11,7 @@ import { setupRoot } from './plugins/root.js'
 import { version } from './schema.js'
 import { sanitizeHTTPSArgument } from './utils.js'
 
-export class ServiceStackable extends BaseStackable {
+export class ServiceCapability extends BaseCapability {
   #app
   #basePath
 
@@ -28,7 +28,7 @@ export class ServiceStackable extends BaseStackable {
     }
 
     const config = this.config
-    this.#basePath = ensureTrailingSlash(cleanBasePath(config.basePath ?? this.serviceId))
+    this.#basePath = ensureTrailingSlash(cleanBasePath(config.basePath ?? this.applicationId))
 
     // Create the application
     this.#app = fastify({
@@ -84,7 +84,8 @@ export class ServiceStackable extends BaseStackable {
   }
 
   async stop () {
-    return this.#app?.close()
+    await super.stop()
+    await this.#app?.close()
   }
 
   async inject (injectParams, onInject) {
@@ -139,7 +140,7 @@ export class ServiceStackable extends BaseStackable {
 
   getMeta () {
     return {
-      composer: {
+      gateway: {
         tcp: typeof this.url !== 'undefined',
         url: this.url,
         prefix: this.basePath ?? this.#basePath,
@@ -234,8 +235,8 @@ export class ServiceStackable extends BaseStackable {
       logLevel: pinoOptions.level
     })
 
-    if (this.context?.serviceId) {
-      pinoOptions.name = this.context.serviceId
+    if (this.context?.applicationId) {
+      pinoOptions.name = this.context.applicationId
     }
 
     if (this.context?.worker?.count > 1 && this.loggerConfig?.base !== null) {

package/lib/plugins/sandbox-wrapper.js

@@ -51,7 +51,6 @@ function stringPatternToRegExp (stringPattern) {
 }
 
 async function sandboxWrapperPlugin (app, options) {
-  // fake require next to the configManager dirname
   const require = createRequire(resolve(app.platformatic.config[kMetadata].root, 'noop.js'))
 
   for (const plugin of options.packages || []) {

package/lib/schema.js

@@ -1178,7 +1178,7 @@ export const openapi = {
   ]
 }
 
-// same as composer/proxy
+// same as gateway/proxy
 export const proxy = {
   anyOf: [
     { type: 'boolean', const: false },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/service",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.8",
   "description": "",
   "main": "index.js",
   "types": "index.d.ts",
@@ -19,7 +19,7 @@
     "@fastify/aws-lambda": "^5.0.0",
     "@fastify/compress": "^8.0.0",
     "bindings": "^1.5.0",
-    "borp": "^0.20.0",
+    "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
     "json-schema-to-typescript": "^15.0.0",
     "neostandard": "^0.12.0",
@@ -42,7 +42,7 @@
     "@fastify/static": "^8.0.0",
     "@fastify/swagger": "^9.0.0",
     "@fastify/under-pressure": "^9.0.0",
-    "@scalar/fastify-api-reference": "1.33.0",
+    "@scalar/fastify-api-reference": "1.34.4",
     "@types/node": "^22.10.6",
     "@types/ws": "^8.5.10",
     "ajv": "^8.12.0",
@@ -67,22 +67,21 @@
     "rfdc": "^1.3.1",
     "semgrator": "^0.3.0",
     "undici": "^7.0.0",
-    "@platformatic/basic": "3.0.0-alpha.5",
-    "@platformatic/metrics": "3.0.0-alpha.5",
-    "@platformatic/generators": "3.0.0-alpha.5",
-    "@platformatic/scalar-theme": "3.0.0-alpha.5",
-    "@platformatic/foundation": "3.0.0-alpha.5",
-    "@platformatic/telemetry": "3.0.0-alpha.5"
+    "@platformatic/basic": "3.0.0-alpha.8",
+    "@platformatic/scalar-theme": "3.0.0-alpha.8",
+    "@platformatic/foundation": "3.0.0-alpha.8",
+    "@platformatic/generators": "3.0.0-alpha.8",
+    "@platformatic/telemetry": "3.0.0-alpha.8",
+    "@platformatic/metrics": "3.0.0-alpha.8"
   },
   "engines": {
     "node": ">=22.18.0"
   },
   "scripts": {
-    "test": "pnpm run lint && borp --concurrency=1 --timeout 1200000 --no-typescript",
-    "coverage": "pnpm run lint && borp -C -X test -X test/fixtures --concurrency=1 --timeout 1200000 --no-typescript",
+    "test": "node --test --test-reporter=cleaner-spec-reporter --test-concurrency=1 --test-timeout=2000000 test/*.test.js test/**/*.test.js",
     "gen-schema": "node lib/schema.js > schema.json",
     "gen-types": "json2ts > config.d.ts < schema.json",
-    "build": "pnpm run gen-schema && pnpm run gen-types",
+    "build": "npm run gen-schema && npm run gen-types",
     "lint": "eslint"
   }
 }

package/schema.json

@@ -1,6 +1,6 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/service/3.0.0-alpha.5.json",
-  "version": "3.0.0-alpha.5",
+  "$id": "https://schemas.platformatic.dev/@platformatic/service/3.0.0-alpha.8.json",
+  "version": "3.0.0-alpha.8",
   "title": "Platformatic Service Config",
   "type": "object",
   "properties": {
@@ -658,13 +658,13 @@
             }
           ]
         },
-        "serviceName": {
+        "applicationName": {
           "type": "string",
-          "description": "The name of the service. Defaults to the folder name if not specified."
+          "description": "The name of the application. Defaults to the folder name if not specified."
         },
         "version": {
           "type": "string",
-          "description": "The version of the service (optional)"
+          "description": "The version of the application (optional)"
         },
         "skip": {
           "type": "array",
@@ -771,7 +771,7 @@
         }
       },
       "required": [
-        "serviceName"
+        "applicationName"
       ],
       "additionalProperties": false
     },
@@ -1014,6 +1014,242 @@
         "basePath": {
           "type": "string"
         },
+        "services": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "anyOf": [
+              {
+                "required": [
+                  "id",
+                  "path"
+                ]
+              },
+              {
+                "required": [
+                  "id",
+                  "url"
+                ]
+              }
+            ],
+            "properties": {
+              "id": {
+                "type": "string"
+              },
+              "path": {
+                "type": "string",
+                "allowEmptyPaths": true,
+                "resolvePath": true
+              },
+              "config": {
+                "type": "string"
+              },
+              "url": {
+                "type": "string"
+              },
+              "gitBranch": {
+                "type": "string",
+                "default": "main"
+              },
+              "useHttp": {
+                "type": "boolean"
+              },
+              "workers": {
+                "anyOf": [
+                  {
+                    "type": "number",
+                    "minimum": 1
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "health": {
+                "type": "object",
+                "default": {},
+                "properties": {
+                  "enabled": {
+                    "anyOf": [
+                      {
+                        "type": "boolean"
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "interval": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "gracePeriod": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxUnhealthyChecks": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 1
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxELU": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxHeapUsed": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0,
+                        "maximum": 1
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxHeapTotal": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  },
+                  "maxYoungGeneration": {
+                    "anyOf": [
+                      {
+                        "type": "number",
+                        "minimum": 0
+                      },
+                      {
+                        "type": "string"
+                      }
+                    ]
+                  }
+                },
+                "additionalProperties": false
+              },
+              "dependencies": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "default": []
+              },
+              "arguments": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
+              "env": {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "string"
+                }
+              },
+              "envfile": {
+                "type": "string"
+              },
+              "sourceMaps": {
+                "type": "boolean",
+                "default": false
+              },
+              "packageManager": {
+                "type": "string",
+                "enum": [
+                  "npm",
+                  "pnpm",
+                  "yarn"
+                ]
+              },
+              "preload": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "resolvePath": true
+                  },
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "resolvePath": true
+                    }
+                  }
+                ]
+              },
+              "nodeOptions": {
+                "type": "string"
+              },
+              "telemetry": {
+                "type": "object",
+                "properties": {
+                  "instrumentations": {
+                    "type": "array",
+                    "description": "An array of instrumentations loaded if telemetry is enabled",
+                    "items": {
+                      "oneOf": [
+                        {
+                          "type": "string"
+                        },
+                        {
+                          "type": "object",
+                          "properties": {
+                            "package": {
+                              "type": "string"
+                            },
+                            "exportName": {
+                              "type": "string"
+                            },
+                            "options": {
+                              "type": "object",
+                              "additionalProperties": true
+                            }
+                          },
+                          "required": [
+                            "package"
+                          ]
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
         "workers": {
           "anyOf": [
             {
@@ -1328,7 +1564,7 @@
               ],
               "default": 10000
             },
-            "service": {
+            "application": {
               "anyOf": [
                 {
                   "type": "number",
@@ -1344,7 +1580,7 @@
           "default": {},
           "required": [
             "runtime",
-            "service"
+            "application"
           ],
           "additionalProperties": false
         },
@@ -1775,13 +2011,13 @@
                 }
               ]
             },
-            "serviceName": {
+            "applicationName": {
               "type": "string",
-              "description": "The name of the service. Defaults to the folder name if not specified."
+              "description": "The name of the application. Defaults to the folder name if not specified."
             },
             "version": {
               "type": "string",
-              "description": "The version of the service (optional)"
+              "description": "The version of the application (optional)"
             },
             "skip": {
               "type": "array",
@@ -1888,7 +2124,7 @@
             }
           },
           "required": [
-            "serviceName"
+            "applicationName"
           ],
           "additionalProperties": false
         },
@@ -1909,7 +2145,7 @@
             }
           }
         },
-        "serviceTimeout": {
+        "applicationTimeout": {
           "anyOf": [
             {
               "type": "number",