@platformatic/basic 2.0.0-alpha.4 → 2.0.0-alpha.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "2.0.0-alpha.4",
+  "version": "2.0.0-alpha.6",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -15,17 +15,13 @@
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "dependencies": {
-    "@babel/generator": "^7.25.0",
-    "@babel/parser": "^7.25.3",
-    "@babel/traverse": "^7.25.3",
-    "@babel/types": "^7.25.2",
     "@fastify/error": "^4.0.0",
-    "light-my-request": "^5.13.0",
     "pino": "^9.3.2",
     "semver": "^7.6.3",
     "undici": "^6.19.5",
-    "@platformatic/config": "2.0.0-alpha.4",
-    "@platformatic/itc": "2.0.0-alpha.4"
+    "@platformatic/config": "2.0.0-alpha.6",
+    "@platformatic/itc": "2.0.0-alpha.6",
+    "@platformatic/utils": "2.0.0-alpha.6"
   },
   "devDependencies": {
     "borp": "^0.17.0",
@@ -40,13 +36,10 @@
     "typescript": "^5.5.4",
     "vite": "^5.4.0",
     "ws": "^8.18.0",
-    "@platformatic/composer": "2.0.0-alpha.4",
-    "@platformatic/utils": "2.0.0-alpha.4",
-    "@platformatic/service": "2.0.0-alpha.4"
+    "@platformatic/composer": "2.0.0-alpha.6",
+    "@platformatic/service": "2.0.0-alpha.6"
   },
   "scripts": {
-    "test": "npm run lint && borp --concurrency=1 --timeout=180000",
-    "coverage": "npm run lint && borp -C -X test -X test/fixtures --concurrency=1 --timeout=180000",
     "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",

package/schema.json

@@ -1,522 +1,12 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.0.0-alpha.4.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.0.0-alpha.6.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Stackable",
   "type": "object",
   "properties": {
     "$schema": {
       "type": "string"
-    },
-    "server": {
-      "type": "object",
-      "properties": {
-        "hostname": {
-          "type": "string"
-        },
-        "port": {
-          "anyOf": [
-            {
-              "type": "integer"
-            },
-            {
-              "type": "string"
-            }
-          ]
-        },
-        "pluginTimeout": {
-          "type": "integer"
-        },
-        "healthCheck": {
-          "anyOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "object",
-              "properties": {
-                "enabled": {
-                  "type": "boolean"
-                },
-                "interval": {
-                  "type": "integer"
-                }
-              },
-              "additionalProperties": true
-            }
-          ]
-        },
-        "ignoreTrailingSlash": {
-          "type": "boolean"
-        },
-        "ignoreDuplicateSlashes": {
-          "type": "boolean"
-        },
-        "connectionTimeout": {
-          "type": "integer"
-        },
-        "keepAliveTimeout": {
-          "type": "integer",
-          "default": 5000
-        },
-        "maxRequestsPerSocket": {
-          "type": "integer"
-        },
-        "forceCloseConnections": {
-          "anyOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "string",
-              "pattern": "^idle$"
-            }
-          ]
-        },
-        "requestTimeout": {
-          "type": "integer"
-        },
-        "bodyLimit": {
-          "type": "integer"
-        },
-        "maxParamLength": {
-          "type": "integer"
-        },
-        "disableRequestLogging": {
-          "type": "boolean"
-        },
-        "exposeHeadRoutes": {
-          "type": "boolean"
-        },
-        "logger": {
-          "anyOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "object",
-              "properties": {
-                "level": {
-                  "type": "string"
-                },
-                "transport": {
-                  "anyOf": [
-                    {
-                      "type": "object",
-                      "properties": {
-                        "target": {
-                          "type": "string",
-                          "resolveModule": true
-                        },
-                        "options": {
-                          "type": "object"
-                        }
-                      },
-                      "additionalProperties": false
-                    },
-                    {
-                      "type": "object",
-                      "properties": {
-                        "targets": {
-                          "type": "array",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "target": {
-                                "type": "string",
-                                "resolveModule": true
-                              },
-                              "options": {
-                                "type": "object"
-                              },
-                              "level": {
-                                "type": "string"
-                              },
-                              "additionalProperties": false
-                            }
-                          }
-                        },
-                        "options": {
-                          "type": "object"
-                        }
-                      },
-                      "additionalProperties": false
-                    }
-                  ]
-                },
-                "pipeline": {
-                  "type": "object",
-                  "properties": {
-                    "target": {
-                      "type": "string",
-                      "resolveModule": true
-                    },
-                    "options": {
-                      "type": "object"
-                    }
-                  },
-                  "additionalProperties": false
-                }
-              },
-              "additionalProperties": true
-            }
-          ]
-        },
-        "serializerOpts": {
-          "type": "object",
-          "properties": {
-            "schema": {
-              "type": "object"
-            },
-            "ajv": {
-              "type": "object"
-            },
-            "rounding": {
-              "type": "string",
-              "enum": [
-                "floor",
-                "ceil",
-                "round",
-                "trunc"
-              ],
-              "default": "trunc"
-            },
-            "debugMode": {
-              "type": "boolean"
-            },
-            "mode": {
-              "type": "string",
-              "enum": [
-                "debug",
-                "standalone"
-              ]
-            },
-            "largeArraySize": {
-              "anyOf": [
-                {
-                  "type": "integer"
-                },
-                {
-                  "type": "string"
-                }
-              ],
-              "default": 20000
-            },
-            "largeArrayMechanism": {
-              "type": "string",
-              "enum": [
-                "default",
-                "json-stringify"
-              ],
-              "default": "default"
-            }
-          }
-        },
-        "caseSensitive": {
-          "type": "boolean"
-        },
-        "requestIdHeader": {
-          "anyOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "boolean",
-              "const": false
-            }
-          ]
-        },
-        "requestIdLogLabel": {
-          "type": "string"
-        },
-        "jsonShorthand": {
-          "type": "boolean"
-        },
-        "trustProxy": {
-          "anyOf": [
-            {
-              "type": "boolean"
-            },
-            {
-              "type": "string"
-            },
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            {
-              "type": "integer"
-            }
-          ]
-        },
-        "http2": {
-          "type": "boolean"
-        },
-        "https": {
-          "type": "object",
-          "properties": {
-            "allowHTTP1": {
-              "type": "boolean"
-            },
-            "key": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "object",
-                  "properties": {
-                    "path": {
-                      "type": "string",
-                      "resolvePath": true
-                    }
-                  },
-                  "additionalProperties": false
-                },
-                {
-                  "type": "array",
-                  "items": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "type": "object",
-                        "properties": {
-                          "path": {
-                            "type": "string",
-                            "resolvePath": true
-                          }
-                        },
-                        "additionalProperties": false
-                      }
-                    ]
-                  }
-                }
-              ]
-            },
-            "cert": {
-              "anyOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "object",
-                  "properties": {
-                    "path": {
-                      "type": "string",
-                      "resolvePath": true
-                    }
-                  },
-                  "additionalProperties": false
-                },
-                {
-                  "type": "array",
-                  "items": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "type": "object",
-                        "properties": {
-                          "path": {
-                            "type": "string",
-                            "resolvePath": true
-                          }
-                        },
-                        "additionalProperties": false
-                      }
-                    ]
-                  }
-                }
-              ]
-            },
-            "requestCert": {
-              "type": "boolean"
-            },
-            "rejectUnauthorized": {
-              "type": "boolean"
-            }
-          },
-          "additionalProperties": false,
-          "required": [
-            "key",
-            "cert"
-          ]
-        },
-        "cors": {
-          "type": "object",
-          "$comment": "See https://github.com/fastify/fastify-cors",
-          "properties": {
-            "origin": {
-              "anyOf": [
-                {
-                  "type": "boolean"
-                },
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "array",
-                  "items": {
-                    "anyOf": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "type": "object",
-                        "properties": {
-                          "regexp": {
-                            "type": "string"
-                          }
-                        },
-                        "required": [
-                          "regexp"
-                        ]
-                      }
-                    ]
-                  }
-                },
-                {
-                  "type": "object",
-                  "properties": {
-                    "regexp": {
-                      "type": "string"
-                    }
-                  },
-                  "required": [
-                    "regexp"
-                  ]
-                }
-              ]
-            },
-            "methods": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            "allowedHeaders": {
-              "type": "string",
-              "description": "Comma separated string of allowed headers."
-            },
-            "exposedHeaders": {
-              "anyOf": [
-                {
-                  "type": "array",
-                  "items": {
-                    "type": "string"
-                  }
-                },
-                {
-                  "type": "string",
-                  "description": "Comma separated string of exposed headers."
-                }
-              ]
-            },
-            "credentials": {
-              "type": "boolean"
-            },
-            "maxAge": {
-              "type": "integer"
-            },
-            "preflightContinue": {
-              "type": "boolean",
-              "default": false
-            },
-            "optionsSuccessStatus": {
-              "type": "integer",
-              "default": 204
-            },
-            "preflight": {
-              "type": "boolean",
-              "default": true
-            },
-            "strictPreflight": {
-              "type": "boolean",
-              "default": true
-            },
-            "hideOptionsRoute": {
-              "type": "boolean",
-              "default": true
-            }
-          },
-          "additionalProperties": false
-        }
-      },
-      "additionalProperties": false
-    },
-    "watch": {
-      "anyOf": [
-        {
-          "type": "object",
-          "properties": {
-            "enabled": {
-              "default": true,
-              "anyOf": [
-                {
-                  "type": "boolean"
-                },
-                {
-                  "type": "string"
-                }
-              ]
-            },
-            "allow": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "minItems": 1,
-              "nullable": true,
-              "default": null
-            },
-            "ignore": {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "nullable": true,
-              "default": null
-            }
-          },
-          "additionalProperties": false
-        },
-        {
-          "type": "boolean"
-        },
-        {
-          "type": "string"
-        }
-      ]
-    },
-    "application": {
-      "type": "object",
-      "properties": {
-        "base": {
-          "type": "string"
-        }
-      },
-      "additionalProperties": false
-    },
-    "vite": {
-      "type": "object",
-      "properties": {
-        "configFile": {
-          "oneOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "boolean"
-            }
-          ]
-        }
-      },
-      "additionalProperties": false
     }
   },
-  "additionalProperties": false
+  "additionalProperties": true
 }

package/test/helper.js

@@ -1,6 +1,7 @@
 import { createDirectory, withResolvers } from '@platformatic/utils'
 import { deepStrictEqual, ok, strictEqual } from 'node:assert'
-import { writeFile } from 'node:fs/promises'
+import { existsSync } from 'node:fs'
+import { readFile, symlink, writeFile } from 'node:fs/promises'
 import { dirname, resolve } from 'node:path'
 import { setTimeout as sleep } from 'node:timers/promises'
 import { Client, request } from 'undici'
@@ -10,11 +11,40 @@ import { buildServer, platformaticRuntime } from '../../runtime/index.js'
 
 export { setTimeout as sleep } from 'node:timers/promises'
 
+const HMR_TIMEOUT = process.env.CI ? 20000 : 10000
 let hrmVersion = Date.now()
-export const fixturesDir = resolve(import.meta.dirname, './fixtures')
+export let fixturesDir
 
-export async function createRuntime (t, path) {
+export function setFixturesDir (directory) {
+  fixturesDir = directory
+}
+
+// This is used to debug tests
+export function pause (url, timeout = 300000) {
+  console.log(`Server is listening at ${url}`)
+  return sleep(timeout)
+}
+
+export async function ensureDependency (directory, pkg, source) {
+  const [namespace, name] = pkg.includes('/') ? pkg.split('/') : ['', pkg]
+  const basedir = resolve(fixturesDir, directory, `node_modules/${namespace}`)
+  const destination = resolve(basedir, name)
+
+  await createDirectory(basedir)
+  if (!existsSync(destination)) {
+    await symlink(source, destination, 'dir')
+  }
+}
+
+export async function createRuntime (t, path, packageRoot) {
   const configFile = resolve(fixturesDir, path)
+
+  if (packageRoot) {
+    const packageName = JSON.parse(await readFile(resolve(packageRoot, 'package.json'), 'utf-8')).name
+    const root = dirname(configFile)
+    await ensureDependency(root, packageName, packageRoot)
+  }
+
   const config = await loadConfig({}, ['-c', configFile], platformaticRuntime)
   const runtime = await buildServer(config.configManager.current)
   const url = await runtime.start()
@@ -30,12 +60,12 @@ export async function getLogs (app) {
   const client = new Client(
     {
       hostname: 'localhost',
-      protocol: 'http:',
+      protocol: 'http:'
     },
     {
       socketPath: app.getManagementApiUrl(),
       keepAliveTimeout: 10,
-      keepAliveMaxTimeout: 10,
+      keepAliveMaxTimeout: 10
     }
   )
 
@@ -44,7 +74,7 @@ export async function getLogs (app) {
 
   const { statusCode, body } = await client.request({
     method: 'GET',
-    path: '/api/v1/logs/all',
+    path: '/api/v1/logs/all'
   })
 
   strictEqual(statusCode, 200)
@@ -58,8 +88,8 @@ export async function getLogs (app) {
     .map(m => JSON.parse(m))
 }
 
-export async function updateHMRVersion () {
-  const versionFile = resolve(fixturesDir, '../tmp/version.js')
+export async function updateHMRVersion (versionFile) {
+  versionFile ??= resolve(fixturesDir, '../tmp/version.js')
   await createDirectory(dirname(versionFile))
   await writeFile(versionFile, `export const version = ${hrmVersion++}\n`, 'utf-8')
 }
@@ -81,10 +111,10 @@ export async function verifyHTMLViaHTTP (baseUrl, path, contents) {
   const html = await body.text()
 
   deepStrictEqual(statusCode, 200)
-  ok(headers['content-type'].startsWith('text/html'))
+  ok(headers['content-type']?.startsWith('text/html'))
 
   for (const content of contents) {
-    ok(html.includes(content))
+    ok(content instanceof RegExp ? content.test(html) : html.includes(content), content)
   }
 }
 
@@ -95,15 +125,15 @@ export async function verifyHTMLViaInject (app, serviceId, url, contents) {
   ok(headers['content-type'].startsWith('text/html'))
 
   for (const content of contents) {
-    ok(html.includes(content))
+    ok(content instanceof RegExp ? content.test(html) : html.includes(content), content)
   }
 }
 
-export async function verifyHMR (baseUrl, path, versionFile, protocol, handler) {
+export async function verifyHMR (baseUrl, path, protocol, handler) {
   const connection = withResolvers()
   const reload = withResolvers()
   const ac = new AbortController()
-  const timeout = sleep(10000, 'timeout', { signal: ac.signal })
+  const timeout = sleep(HMR_TIMEOUT, 'timeout', { signal: ac.signal })
 
   const url = baseUrl.replace('http:', 'ws:') + path
   const webSocket = new WebSocket(url, protocol)