@platformatic/basic 2.0.0-alpha.5 → 2.0.0-alpha.7

package/index.js

@@ -3,6 +3,7 @@ import { readFile } from 'node:fs/promises'
 import { createRequire } from 'node:module'
 import { relative, resolve } from 'node:path'
 import { workerData } from 'node:worker_threads'
+import pino from 'pino'
 import { packageJson, schema } from './lib/schema.js'
 import { importFile } from './lib/utils.js'
 
@@ -28,15 +29,6 @@ async function importStackablePackage (opts, pkg, autodetectDescription) {
       errorMessage += 'in the root package.json file.'
     }
 
-    if (!opts.config) {
-      const serviceRoot = relative(process.cwd(), opts.context.directory)
-      errorMessage += [
-        '', // Do not remove this
-        `Platformatic has auto-detected that service ${opts.context.serviceId} ${autodetectDescription}.`,
-        `We suggest you create a platformatic.application.json file in the folder ${serviceRoot} with the "$schema" property set to "https://schemas.platformatic.dev/${pkg}/${packageJson.version}.json".`,
-      ].join('\n')
-    }
-
     throw new Error(errorMessage)
   }
 }
@@ -53,7 +45,9 @@ async function buildStackable (opts) {
     rootPackageJson = {}
   }
 
-  if (!opts.config) {
+  const hadConfig = opts.config
+
+  if (!hadConfig) {
     const candidate = resolve(root, 'platformatic.application.json')
 
     if (existsSync(candidate)) {
@@ -66,21 +60,59 @@ async function buildStackable (opts) {
   if (dependencies?.next || devDependencies?.next) {
     autodetectDescription = 'is using Next.js'
     toImport = '@platformatic/next'
+  } else if (dependencies?.['@remix-run/dev'] || devDependencies?.['@remix-run/dev']) {
+    autodetectDescription = 'is using Remix'
+    toImport = '@platformatic/remix'
   } else if (dependencies?.vite || devDependencies?.vite) {
     autodetectDescription = 'is using Vite'
     toImport = '@platformatic/vite'
+  } else if (dependencies?.astro || devDependencies?.astro) {
+    autodetectDescription = 'is using Astro'
+    toImport = '@platformatic/astro'
   }
 
   const imported = await importStackablePackage(opts, toImport, autodetectDescription)
+
+  const serviceRoot = relative(process.cwd(), opts.context.directory)
+  if (!hadConfig && !existsSync(resolve(serviceRoot, 'platformatic.application.json'))) {
+    const logger = pino({
+      level: opts.context.serverConfig?.logger?.level ?? 'warn',
+      name: opts.context.serviceId
+    })
+
+    logger.warn(
+      [
+        `Platformatic has auto-detected that service ${opts.context.serviceId} ${autodetectDescription}.\n`,
+        `We suggest you create a platformatic.application.json file in the folder ${serviceRoot} with the "$schema" `,
+        `property set to "https://schemas.platformatic.dev/${toImport}/${packageJson.version}.json".`
+      ].join('')
+    )
+  }
+
   return imported.buildStackable(opts)
 }
 
+/* c8 ignore next 3 */
+export function transformConfig () {
+  // This is currently empty but it left as a placeholder for the future
+}
+
+export const schemaOptions = {
+  useDefaults: true,
+  coerceTypes: true,
+  allErrors: true,
+  strict: false
+}
+
 export default {
   configType: 'nodejs',
-  configManagerConfig: {},
+  configManagerConfig: {
+    schemaOptions,
+    transformConfig
+  },
   buildStackable,
   schema,
-  version: packageJson.version,
+  version: packageJson.version
 }
 
 export * from './lib/base.js'

package/lib/base.js

@@ -13,7 +13,7 @@ export class BaseStackable {
 
     // Setup the logger
     const pinoOptions = {
-      level: (this.configManager.current.server ?? this.serverConfig)?.logger?.level ?? 'trace',
+      level: (this.configManager.current.server ?? this.serverConfig)?.logger?.level ?? 'trace'
     }
 
     if (this.id) {
@@ -22,10 +22,10 @@ export class BaseStackable {
     this.logger = pino(pinoOptions)
 
     // Setup globals
-    globalThis.platformatic = {
+    this.registerGlobals({
       setOpenapiSchema: this.setOpenapiSchema.bind(this),
-      setGraphqlSchema: this.setGraphqlSchema.bind(this),
-    }
+      setGraphqlSchema: this.setGraphqlSchema.bind(this)
+    })
   }
 
   getUrl () {
@@ -45,7 +45,7 @@ export class BaseStackable {
       enabled,
       path: this.root,
       allow: config.watch?.allow,
-      ignore: config.watch?.ignore,
+      ignore: config.watch?.ignore
     }
   }
 
@@ -57,8 +57,11 @@ export class BaseStackable {
     return this
   }
 
-  async getMetrics ({ format }) {
-    return null
+  async collectMetrics () {
+    return {
+      defaultMetrics: true,
+      httpMetrics: false
+    }
   }
 
   async getOpenapiSchema () {
@@ -81,4 +84,8 @@ export class BaseStackable {
     const logLevel = level ?? 'info'
     this.logger[logLevel](message)
   }
+
+  registerGlobals (globals) {
+    globalThis.platformatic = Object.assign(globalThis.platformatic ?? {}, globals)
+  }
 }

package/lib/schema.js

@@ -7,25 +7,51 @@ const application = {
   type: 'object',
   properties: {
     basePath: {
-      type: 'string',
-    },
+      type: 'string'
+    }
   },
-  additionalProperties: false,
+  additionalProperties: false
 }
 
 const watch = {
   anyOf: [
     schemas.watch,
     {
-      type: 'boolean',
+      type: 'boolean'
     },
     {
+      type: 'string'
+    }
+  ]
+}
+
+const deploy = {
+  type: 'object',
+  properties: {
+    include: {
+      type: 'array',
+      items: {
+        type: 'string'
+      },
+      default: ['dist']
+    },
+    buildCommand: {
       type: 'string',
+      default: 'npm run build'
     },
-  ],
+    installCommand: {
+      type: 'string',
+      default: 'npm ci --omit-dev'
+    },
+    startCommand: {
+      type: 'string',
+      default: 'npm run start'
+    }
+  },
+  default: {}
 }
 
-export const schemaComponents = { application, watch }
+export const schemaComponents = { application, deploy, watch }
 
 export const schema = {
   $id: `https://schemas.platformatic.dev/@platformatic/basic/${packageJson.version}.json`,
@@ -34,10 +60,10 @@ export const schema = {
   type: 'object',
   properties: {
     $schema: {
-      type: 'string',
-    },
+      type: 'string'
+    }
   },
-  additionalProperties: true,
+  additionalProperties: true
 }
 
 /* c8 ignore next 3 */

package/lib/worker/child-manager.js

@@ -13,7 +13,16 @@ export class ChildManager extends ITC {
   #originalNodeOptions
 
   constructor ({ loader, context }) {
-    super({})
+    super({
+      handlers: {
+        log (message) {
+          workerData.loggingPort.postMessage(JSON.parse(message))
+        },
+        fetch: request => {
+          return this.#fetch(request)
+        }
+      }
+    })
 
     const childHandler = ({ process: child }) => {
       unsubscribe('child_process', childHandler)
@@ -28,12 +37,6 @@ export class ChildManager extends ITC {
 
     subscribe('child_process', childHandler)
 
-    this.handle('log', message => {
-      workerData.loggingPort.postMessage(JSON.parse(message))
-    })
-
-    this.handle('fetch', this.#fetch.bind(this))
-
     this.#prepareChildEnvironment(loader, context)
   }
 
@@ -75,7 +78,7 @@ export class ChildManager extends ITC {
     this.#injectedNodeOptions = [
       `--import="data:text/javascript,${loaderScript.replaceAll(/\n/g, '')}"`,
       `--import=${childProcessWorkerFile}`,
-      process.env.NODE_OPTIONS ?? '',
+      process.env.NODE_OPTIONS ?? ''
     ].join(' ')
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/basic",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.7",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -19,9 +19,9 @@
     "pino": "^9.3.2",
     "semver": "^7.6.3",
     "undici": "^6.19.5",
-    "@platformatic/config": "2.0.0-alpha.5",
-    "@platformatic/utils": "2.0.0-alpha.5",
-    "@platformatic/itc": "2.0.0-alpha.5"
+    "@platformatic/config": "2.0.0-alpha.7",
+    "@platformatic/itc": "2.0.0-alpha.7",
+    "@platformatic/utils": "2.0.0-alpha.7"
   },
   "devDependencies": {
     "borp": "^0.17.0",
@@ -36,8 +36,8 @@
     "typescript": "^5.5.4",
     "vite": "^5.4.0",
     "ws": "^8.18.0",
-    "@platformatic/composer": "2.0.0-alpha.5",
-    "@platformatic/service": "2.0.0-alpha.5"
+    "@platformatic/composer": "2.0.0-alpha.7",
+    "@platformatic/service": "2.0.0-alpha.7"
   },
   "scripts": {
     "gen-schema": "node lib/schema.js > schema.json",

package/schema.json

@@ -1,5 +1,5 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.0.0-alpha.5.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/basic/2.0.0-alpha.7.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Platformatic Stackable",
   "type": "object",

package/test/helper.js

@@ -11,6 +11,7 @@ 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 let fixturesDir
 
@@ -59,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
     }
   )
 
@@ -73,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)
@@ -113,7 +114,7 @@ export async function verifyHTMLViaHTTP (baseUrl, path, contents) {
   ok(headers['content-type']?.startsWith('text/html'))
 
   for (const content of contents) {
-    ok(content instanceof RegExp ? content.test(html) : html.includes(content))
+    ok(content instanceof RegExp ? content.test(html) : html.includes(content), content)
   }
 }
 
@@ -124,7 +125,7 @@ export async function verifyHTMLViaInject (app, serviceId, url, contents) {
   ok(headers['content-type'].startsWith('text/html'))
 
   for (const content of contents) {
-    ok(content instanceof RegExp ? content.test(html) : html.includes(content))
+    ok(content instanceof RegExp ? content.test(html) : html.includes(content), content)
   }
 }
 
@@ -132,7 +133,7 @@ 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)