@platformatic/remix 2.71.1-alpha.0 → 3.0.0-alpha.1

package/config.d.ts

@@ -5,7 +5,7 @@
  * and run json-schema-to-typescript to regenerate this file.
  */
 
-export interface PlatformaticRemixStackable {
+export interface PlatformaticRemixConfig {
   $schema?: string;
   logger?: {
     level: (

package/index.js

@@ -1,272 +1,31 @@
-import {
-  transformConfig as basicTransformConfig,
-  cleanBasePath,
-  ensureTrailingSlash,
-  errors,
-  getServerUrl,
-  importFile,
-  resolvePackage,
-  schemaOptions
-} from '@platformatic/basic'
-import { ConfigManager } from '@platformatic/config'
-import { features } from '@platformatic/utils'
-import { ViteStackable } 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, schema } from './lib/schema.js'
-
-const supportedVersions = '^2.0.0'
-
-export class RemixStackable extends ViteStackable {
-  #app
-  #server
-  #dispatcher
-  #remix
-  #basePath
-
-  constructor (options, root, configManager) {
-    super(options, root, configManager)
-
-    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.configManager.current
-    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.configManager.current
-    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 () {
-    if (this.childManager) {
-      return this.stopCommand()
-    }
-
-    if (this.isProduction) {
-      return this.#stopProduction()
-    }
-
-    return super.stop()
-  }
-
-  async build () {
-    const config = this.configManager.current
-    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 {
-      composer: {
-        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.configManager.current.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()
-      })
-    })
-  }
+import { transform as basicTransform, resolve, validationOptions } from '@platformatic/basic'
+import { kMetadata, loadConfiguration as utilsLoadConfiguration } from '@platformatic/utils'
+import { schema } from './lib/schema.js'
+import { RemixStackable } from './lib/stackable.js'
+
+/* c8 ignore next 5 */
+export async function transform (config, schema, options) {
+  config = await basicTransform(config, schema, options)
+  config.watch = { enabled: false }
+  return config
 }
 
-/* c8 ignore next 9 */
-function transformConfig () {
-  if (this.current.watch === undefined) {
-    this.current.watch = { enabled: false }
-  }
-
-  if (typeof this.current.watch !== 'object') {
-    this.current.watch = { enabled: this.current.watch || false }
-  }
+export async function loadConfiguration (configOrRoot, sourceOrConfig, context) {
+  const { root, source } = await resolve(configOrRoot, sourceOrConfig, 'application')
 
-  return basicTransformConfig.call(this)
-}
-
-export async function buildStackable (opts) {
-  const root = opts.context.directory
-
-  const configManager = new ConfigManager({
-    schema,
-    source: opts.config ?? {},
-    schemaOptions,
-    transformConfig,
-    dirname: root,
-    context: opts.context
+  return utilsLoadConfiguration(source, context?.schema ?? schema, {
+    validationOptions,
+    transform,
+    replaceEnv: true,
+    root,
+    ...context
   })
-  await configManager.parseAndValidate()
-
-  return new RemixStackable(opts, root, configManager)
 }
 
-export { schema, schemaComponents } from './lib/schema.js'
-
-export default {
-  configType: 'remix',
-  configManagerConfig: {
-    schemaOptions,
-    transformConfig
-  },
-  buildStackable,
-  schema,
-  version: packageJson.version,
-  modulesToLoad: []
+export async function create (configOrRoot, sourceOrConfig, context) {
+  const config = await loadConfiguration(configOrRoot, sourceOrConfig, context)
+  return new RemixStackable(config[kMetadata].root, config, context)
 }
+
+export { packageJson, schema, schemaComponents, version } from './lib/schema.js'
+export * from './lib/stackable.js'

package/lib/schema.js

@@ -2,8 +2,10 @@ import { schemaComponents as basicSchemaComponents } from '@platformatic/basic'
 import { schemaComponents as utilsSchemaComponents } from '@platformatic/utils'
 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: {

package/lib/stackable.js

@@ -0,0 +1,224 @@
+import {
+  cleanBasePath,
+  ensureTrailingSlash,
+  errors,
+  getServerUrl,
+  importFile,
+  resolvePackage
+} from '@platformatic/basic'
+import { features } from '@platformatic/utils'
+import { ViteStackable } 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 RemixStackable extends ViteStackable {
+  #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 () {
+    if (this.childManager) {
+      return this.stopCommand()
+    }
+
+    if (this.isProduction) {
+      return this.#stopProduction()
+    }
+
+    return super.stop()
+  }
+
+  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 {
+      composer: {
+        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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@platformatic/remix",
-  "version": "2.71.1-alpha.0",
+  "version": "3.0.0-alpha.1",
   "description": "Platformatic Remix Stackable",
   "main": "index.js",
   "type": "module",
@@ -20,10 +20,9 @@
     "light-my-request": "^6.0.0",
     "pino-http": "^10.2.0",
     "semver": "^7.6.3",
-    "@platformatic/config": "2.71.1-alpha.0",
-    "@platformatic/basic": "2.71.1-alpha.0",
-    "@platformatic/utils": "2.71.1-alpha.0",
-    "@platformatic/vite": "2.71.1-alpha.0"
+    "@platformatic/utils": "3.0.0-alpha.1",
+    "@platformatic/vite": "3.0.0-alpha.1",
+    "@platformatic/basic": "3.0.0-alpha.1"
   },
   "devDependencies": {
     "@remix-run/dev": "^2.16.8",
@@ -40,12 +39,12 @@
     "typescript": "^5.5.4",
     "vite": "^5.4.2",
     "ws": "^8.18.0",
-    "@platformatic/composer": "2.71.1-alpha.0",
-    "@platformatic/service": "2.71.1-alpha.0"
+    "@platformatic/composer": "3.0.0-alpha.1",
+    "@platformatic/service": "3.0.0-alpha.1"
   },
   "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": "npm run lint && borp --concurrency=1 --timeout 1200000",
+    "coverage": "npm run lint && borp -C -X test -X test/fixtures --concurrency=1 --timeout 1200000",
     "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,7 +1,7 @@
 {
-  "$id": "https://schemas.platformatic.dev/@platformatic/remix/2.71.1-alpha.0.json",
+  "$id": "https://schemas.platformatic.dev/@platformatic/remix/3.0.0-alpha.1.json",
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "title": "Platformatic Remix Stackable",
+  "title": "Platformatic Remix Config",
   "type": "object",
   "properties": {
     "$schema": {