@platformatic/remix 3.4.1 → 3.5.1

package/lib/capability.js

@@ -0,0 +1,226 @@
+import {
+  cleanBasePath,
+  ensureTrailingSlash,
+  errors,
+  getServerUrl,
+  importFile,
+  resolvePackage
+} from '@platformatic/basic'
+import { features } from '@platformatic/foundation'
+import { ViteCapability } from '@platformatic/vite'
+import { createRequestHandler } from '@remix-run/express'
+import express from 'express'
+import inject from 'light-my-request'
+import { existsSync } from 'node:fs'
+import { readFile } from 'node:fs/promises'
+import { dirname, resolve } from 'node:path'
+import { pinoHttp } from 'pino-http'
+import { satisfies } from 'semver'
+import { packageJson } from './schema.js'
+
+const supportedVersions = '^2.0.0'
+
+export class RemixCapability extends ViteCapability {
+  #app
+  #server
+  #remix
+  #basePath
+
+  constructor (root, config, context) {
+    super(root, config, context)
+    this.type = 'remix'
+    this.version = packageJson.version
+  }
+
+  async init () {
+    await super.init()
+
+    if (!this.isProduction) {
+      this.#remix = resolve(dirname(resolvePackage(this.root, '@remix-run/dev')), '..')
+      const remixPackage = JSON.parse(await readFile(resolve(this.#remix, 'package.json'), 'utf-8'))
+
+      if (!satisfies(remixPackage.version, supportedVersions)) {
+        throw new errors.UnsupportedVersion('@remix-run/dev', remixPackage.version, supportedVersions)
+      }
+    }
+
+    const config = this.config
+    this.#basePath = config.application?.basePath
+      ? ensureTrailingSlash(cleanBasePath(config.application?.basePath))
+      : undefined
+
+    this.registerGlobals({ basePath: this.#basePath })
+
+    this.subprocessTerminationSignal = 'SIGKILL'
+  }
+
+  async start ({ listen }) {
+    // Make this idempotent
+    if (this.url) {
+      return this.url
+    }
+
+    const config = this.config
+    const command = config.application.commands[this.isProduction ? 'production' : 'development']
+
+    if (command) {
+      return this.startWithCommand(command)
+    }
+
+    return this.isProduction ? this.#startProduction(listen) : this.#startDevelopment(listen)
+  }
+
+  async stop () {
+    await super.stop()
+
+    if (this.childManager) {
+      return this.stopCommand()
+    }
+
+    if (this.isProduction) {
+      return this.#stopProduction()
+    } else if (this.#app) {
+      return this.#app.close()
+    }
+  }
+
+  async build () {
+    const config = this.config
+    const command = config.application.commands.build
+    const basePath = config.application?.basePath
+      ? ensureTrailingSlash(cleanBasePath(config.application?.basePath))
+      : undefined
+
+    if (command) {
+      return this.buildWithCommand(command, basePath)
+    }
+
+    await this.init()
+    const { viteBuild } = await importFile(resolve(this.#remix, 'dist/cli/commands.js'))
+
+    try {
+      globalThis.platformatic.isBuilding = true
+
+      await viteBuild(this.root, {
+        emptyOutDir: true,
+        logLevel: this.logger.level,
+        mode: 'production',
+        profile: false
+      })
+    } finally {
+      globalThis.platformatic.isBuilding = false
+    }
+  }
+
+  async inject (injectParams, onInject) {
+    if (!this.isProduction) {
+      return super.inject(injectParams, onInject)
+    }
+
+    const res = await inject(this.#app, injectParams, onInject)
+
+    /* c8 ignore next 3 */
+    if (onInject) {
+      return
+    } // Since inject might be called from the main thread directly via ITC, let's clean it up
+
+    const { statusCode, headers, body, payload, rawPayload } = res
+    return { statusCode, headers, body, payload, rawPayload }
+  }
+
+  getMeta () {
+    if (!this.isProduction) {
+      return super.getMeta()
+    }
+
+    return {
+      gateway: {
+        tcp: typeof this.url !== 'undefined',
+        url: this.url,
+        prefix: this.basePath ?? this.#basePath,
+        wantsAbsoluteUrls: true,
+        needsRootTrailingSlash: true
+      }
+    }
+  }
+
+  async #startDevelopment (listen) {
+    const preloadViteEsmPath = resolve(this.#remix, './dist/vite/import-vite-esm-sync.js')
+
+    // Older versions
+    if (existsSync(preloadViteEsmPath)) {
+      const { preloadViteEsm } = await importFile(resolve(this.#remix, './dist/vite/import-vite-esm-sync.js'))
+      await preloadViteEsm()
+    } else {
+      const { preloadVite } = await importFile(resolve(this.#remix, './dist/vite/vite.js'))
+      await preloadVite()
+    }
+
+    await super.start({ listen })
+
+    /* c8 ignore next 3 */
+    if (!this._getVite().config.plugins.some(p => p.name === 'remix')) {
+      this.logger.warn('Could not find Remix plugin in your Vite configuration. Continuing as plain Vite application.')
+    }
+
+    await this._collectMetrics()
+  }
+
+  async #startProduction (listen) {
+    // Listen if entrypoint
+    if (this.#app && listen) {
+      const serverOptions = this.serverConfig
+      const listenOptions = { host: serverOptions?.hostname || '127.0.0.1', port: serverOptions?.port || 0 }
+
+      if (this.isProduction && features.node.reusePort) {
+        listenOptions.reusePort = true
+      }
+
+      this.#server = await new Promise((resolve, reject) => {
+        return this.#app
+          .listen(listenOptions, function () {
+            resolve(this)
+          })
+          .on('error', reject)
+      })
+
+      this.url = getServerUrl(this.#server)
+
+      return this.url
+    }
+
+    const outputDirectory = this.config.remix.outputDirectory
+    this.verifyOutputDirectory(resolve(this.root, outputDirectory))
+
+    const build = await importFile(resolve(this.root, `${outputDirectory}/server/index.js`))
+    this.#basePath = ensureTrailingSlash(cleanBasePath(build.basename))
+
+    // Setup express app
+    this.#app = express()
+    this.#app.disable('x-powered-by')
+    this.#app.use(pinoHttp({ logger: this.logger }))
+    this.#app.use(this.#basePath, express.static(resolve(this.root, `${outputDirectory}/client`)))
+    this.#app.all(`${ensureTrailingSlash(cleanBasePath(this.#basePath))}*`, createRequestHandler({ build }))
+
+    await this._collectMetrics()
+    return this.url
+  }
+
+  async #stopProduction () {
+    /* c8 ignore next 3 */
+    if (!this.#server?.listening) {
+      return
+    }
+
+    return new Promise((resolve, reject) => {
+      this.#server.close(error => {
+        /* c8 ignore next 3 */
+        if (error) {
+          return reject(error)
+        }
+
+        resolve()
+      })
+    })
+  }
+}

package/lib/schema.js

@@ -1,9 +1,11 @@
 import { schemaComponents as basicSchemaComponents } from '@platformatic/basic'
-import { schemaComponents as utilsSchemaComponents } from '@platformatic/utils'
+import { schemaComponents as utilsSchemaComponents } from '@platformatic/foundation'
 import { schemaComponents as viteSchemaComponents } from '@platformatic/vite'
 import { readFileSync } from 'node:fs'
+import { resolve } from 'node:path'
 
-export const packageJson = JSON.parse(readFileSync(new URL('../package.json', import.meta.url), 'utf-8'))
+export const packageJson = JSON.parse(readFileSync(resolve(import.meta.dirname, '../package.json'), 'utf8'))
+export const version = packageJson.version
 
 export const remix = {
   type: 'object',
@@ -22,7 +24,7 @@ export const schemaComponents = { remix }
 export const schema = {
   $id: `https://schemas.platformatic.dev/@platformatic/remix/${packageJson.version}.json`,
   $schema: 'http://json-schema.org/draft-07/schema#',
-  title: 'Platformatic Remix Stackable',
+  title: 'Platformatic Remix Config',
   type: 'object',
   properties: {
     $schema: {
@@ -31,7 +33,8 @@ export const schema = {
     logger: utilsSchemaComponents.logger,
     server: utilsSchemaComponents.server,
     watch: basicSchemaComponents.watch,
-    application: basicSchemaComponents.application,
+    application: basicSchemaComponents.buildableApplication,
+    runtime: utilsSchemaComponents.wrappedRuntime,
     vite: viteSchemaComponents.vite,
     remix
   },

package/package.json

@@ -1,54 +1,57 @@
 {
   "name": "@platformatic/remix",
-  "version": "3.4.1",
-  "description": "Platformatic Remix Stackable",
+  "version": "3.5.1",
+  "description": "Platformatic Remix Capability",
   "main": "index.js",
   "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/platformatic/platformatic.git"
   },
-  "author": "Paolo Insogna <paolo@cowtech.it>",
+  "author": "Platformatic Inc. <oss@platformatic.dev> (https://platformatic.dev)",
   "license": "Apache-2.0",
   "bugs": {
     "url": "https://github.com/platformatic/platformatic/issues"
   },
   "homepage": "https://github.com/platformatic/platformatic#readme",
   "dependencies": {
-    "@remix-run/express": "^2.11.2",
-    "light-my-request": "^6.0.0",
+    "@remix-run/express": "^2.16.8",
     "express": "^4.19.2",
+    "light-my-request": "^6.0.0",
     "pino-http": "^10.2.0",
     "semver": "^7.6.3",
-    "@platformatic/basic": "3.4.1",
-    "@platformatic/vite": "3.4.1",
-    "@platformatic/config": "3.4.1",
-    "@platformatic/utils": "3.4.1"
+    "@platformatic/basic": "3.5.1",
+    "@platformatic/foundation": "3.5.1",
+    "@platformatic/vite": "3.5.1"
   },
   "devDependencies": {
-    "@remix-run/dev": "^2.11.2",
-    "@remix-run/node": "^2.11.2",
-    "@remix-run/react": "^2.11.2",
-    "borp": "^0.17.0",
+    "@remix-run/dev": "^2.16.8",
+    "@remix-run/node": "^2.16.8",
+    "@remix-run/react": "^2.16.8",
+    "@types/react": "^19.1.11",
+    "@types/react-dom": "^19.1.7",
+    "cleaner-spec-reporter": "^0.5.0",
     "eslint": "9",
     "fastify": "^5.0.0",
     "isbot": "^5.1.17",
     "json-schema-to-typescript": "^15.0.1",
-    "neostandard": "^0.11.1",
-    "react": "^18.3.1",
-    "react-dom": "^18.3.1",
+    "neostandard": "^0.12.0",
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
     "typescript": "^5.5.4",
     "vite": "^5.4.2",
     "ws": "^8.18.0",
-    "@platformatic/composer": "3.4.1",
-    "@platformatic/service": "3.4.1"
+    "@platformatic/gateway": "3.5.1",
+    "@platformatic/service": "3.5.1"
+  },
+  "engines": {
+    "node": ">=22.19.0"
   },
   "scripts": {
-    "test": "npm run lint && borp --concurrency=1 --no-timeout",
-    "coverage": "npm run lint && borp -C -X test -X test/fixtures --concurrency=1 --no-timeout",
+    "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"
   }
 }