@ossy/app 1.8.0 → 1.10.0

package/cli/build.js

@@ -11,6 +11,7 @@ import nodeExternals from 'rollup-plugin-node-externals'
 import copy from 'rollup-plugin-copy';
 import replace from '@rollup/plugin-replace';
 import arg from 'arg'
+import prerenderReactTask from './prerender-react.task.js'
 
 export const PAGE_FILE_PATTERN = /\.page\.(jsx?|tsx?)$/
 export const API_FILE_PATTERN = /\.api\.(mjs|cjs|js)$/
@@ -23,7 +24,7 @@ export const OSSY_RESOURCE_TEMPLATES_OUT = '.ossy-system-templates.generated.js'
 /** Rollup output paths for JS served to the browser (see `entryFileNames` / `chunkFileNames`). */
 const BROWSER_STATIC_PREFIX = 'public/static/'
 
-function minifyBrowserStaticChunks () {
+export function minifyBrowserStaticChunks () {
   return {
     name: 'minify-browser-static-chunks',
     async renderChunk (code, chunk, outputOptions) {
@@ -55,11 +56,10 @@ export const OSSY_GEN_PAGES_BASENAME = 'pages.generated.jsx'
 export const OSSY_GEN_API_BASENAME = 'api.generated.js'
 export const OSSY_GEN_TASKS_BASENAME = 'tasks.generated.js'
 
-/** Bundled Node entries consumed by copied `build/server.js` / `build/worker.js`. */
-export const OSSY_PAGES_SERVER_BUNDLE = 'pages.bundle.js'
+/** Bundled pages + React for build-time prerender only (not loaded by `server.js`). */
+export const OSSY_PAGES_PRERENDER_BUNDLE = 'pages.prerender.bundle.js'
 export const OSSY_API_SERVER_BUNDLE = 'api.bundle.js'
 export const OSSY_TASKS_SERVER_BUNDLE = 'tasks.bundle.js'
-export const OSSY_CONFIG_RUNTIME_BASENAME = 'config.runtime.js'
 export const OSSY_MIDDLEWARE_RUNTIME_BASENAME = 'middleware.runtime.js'
 
 /** Per-page client entries: `hydrate-<pageId>.jsx` under `.ossy/` */
@@ -223,16 +223,10 @@ export async function bundleOssyNodeEntry ({ inputPath, outputFile, nodeEnv }) {
 }
 
 /**
- * Re-exports the resolved config and middleware via `file:` URLs so `src/config.js` can keep
- * relative imports (copying those files into `build/` would break them).
+ * Re-exports middleware via `file:` URL so `src/middleware.js` can keep relative imports.
  */
-export function writeAppRuntimeShims ({ configSourcePath, middlewareSourcePath, ossyDir }) {
-  const cfgHref = url.pathToFileURL(path.resolve(configSourcePath)).href
+export function writeAppRuntimeShims ({ middlewareSourcePath, ossyDir }) {
   const mwHref = url.pathToFileURL(path.resolve(middlewareSourcePath)).href
-  fs.writeFileSync(
-    path.join(ossyDir, OSSY_CONFIG_RUNTIME_BASENAME),
-    `// Generated by @ossy/app — do not edit\nexport { default } from '${cfgHref}'\n`
-  )
   fs.writeFileSync(
     path.join(ossyDir, OSSY_MIDDLEWARE_RUNTIME_BASENAME),
     `// Generated by @ossy/app — do not edit\nexport { default } from '${mwHref}'\n`
@@ -241,7 +235,7 @@ export function writeAppRuntimeShims ({ configSourcePath, middlewareSourcePath,
 
 /**
  * Copies framework runtime into `build/`: server, worker entry, proxy.
- * Config/middleware load via `./.ossy/config.runtime.js` and `middleware.runtime.js`.
+ * Middleware loads via `./.ossy/middleware.runtime.js`.
  */
 export function copyOssyAppRuntime ({ scriptDir, buildPath }) {
   for (const name of ['server.js', 'proxy-internal.js']) {
@@ -656,7 +650,7 @@ export const build = async (cliArgs) => {
       ? configPath
       : path.resolve(scriptDir, 'default-config.js')
 
-    const pagesBundlePath = path.join(ossyDir, OSSY_PAGES_SERVER_BUNDLE)
+    const pagesBundlePath = path.join(ossyDir, OSSY_PAGES_PRERENDER_BUNDLE)
     const apiBundlePath = path.join(ossyDir, OSSY_API_SERVER_BUNDLE)
     const tasksBundlePath = path.join(ossyDir, OSSY_TASKS_SERVER_BUNDLE)
 
@@ -678,37 +672,24 @@ export const build = async (cliArgs) => {
     })
 
     writeAppRuntimeShims({
-      configSourcePath,
       middlewareSourcePath,
       ossyDir,
     })
     copyOssyAppRuntime({ scriptDir, buildPath })
 
-    const clientPlugins = createOssyClientRollupPlugins({
-      nodeEnv: 'production',
-      copyPublicFrom: publicDir,
-      buildPath,
-    })
-
     if (Object.keys(clientHydrateInput).length > 0) {
-      const clientBundle = await rollup({
-        input: clientHydrateInput,
-        plugins: clientPlugins,
-      })
-      await clientBundle.write({
-        dir: buildPath,
-        format: 'esm',
-        entryFileNames ({ name }) {
-          if (name.startsWith('hydrate__')) {
-            const pageId = name.slice('hydrate__'.length)
-            return `public/static/hydrate-${pageId}.js`
-          }
-          return 'public/static/[name].js'
-        },
-        chunkFileNames: 'public/static/[name]-[hash].js',
-        plugins: [minifyBrowserStaticChunks()],
+      await prerenderReactTask.handler({
+        op: 'runProduction',
+        clientHydrateInput,
+        pageFilesLength: pageFiles.length,
+        copyPublicFrom: publicDir,
+        buildPath,
+        nodeEnv: 'production',
+        pagesBundlePath,
+        configSourcePath,
+        createClientRollupPlugins: createOssyClientRollupPlugins,
+        minifyBrowserStaticChunks,
       })
-      await clientBundle.close()
     }
 
     console.log('[@ossy/app][build] Finished');

package/cli/dev.js

@@ -21,13 +21,14 @@ import {
   OSSY_GEN_PAGES_BASENAME,
   OSSY_GEN_API_BASENAME,
   OSSY_GEN_TASKS_BASENAME,
-  OSSY_PAGES_SERVER_BUNDLE,
+  OSSY_PAGES_PRERENDER_BUNDLE,
   OSSY_API_SERVER_BUNDLE,
   OSSY_TASKS_SERVER_BUNDLE,
   writeResourceTemplatesBarrelIfPresent,
   resourceTemplatesDir,
   OSSY_RESOURCE_TEMPLATES_OUT,
 } from './build.js';
+import prerenderReactTask from './prerender-react.task.js'
 import { watch } from 'rollup';
 import arg from 'arg'
 import { spawn } from 'node:child_process'
@@ -89,7 +90,7 @@ export const dev = async (cliArgs) => {
       ? configPath
       : path.resolve(scriptDir, 'default-config.js')
 
-    const pagesBundlePath = path.join(ossyDir, OSSY_PAGES_SERVER_BUNDLE)
+    const pagesBundlePath = path.join(ossyDir, OSSY_PAGES_PRERENDER_BUNDLE)
     const apiBundlePath = path.join(ossyDir, OSSY_API_SERVER_BUNDLE)
     const tasksBundlePath = path.join(ossyDir, OSSY_TASKS_SERVER_BUNDLE)
     const tasksGeneratedPath = path.join(ossyDir, OSSY_GEN_TASKS_BASENAME)
@@ -111,7 +112,6 @@ export const dev = async (cliArgs) => {
         nodeEnv: 'development',
       })
       writeAppRuntimeShims({
-        configSourcePath,
         middlewareSourcePath,
         ossyDir,
       })
@@ -235,11 +235,22 @@ export const dev = async (cliArgs) => {
       }
       if (event.code === 'END') {
         writeAppRuntimeShims({
-          configSourcePath,
           middlewareSourcePath,
           ossyDir,
         })
         copyOssyAppRuntime({ scriptDir, buildPath })
+        if (pageFiles.length > 0) {
+          try {
+            await prerenderReactTask.handler({
+              op: 'prerenderPagesParallel',
+              pagesBundlePath,
+              configSourcePath,
+              publicDir: path.join(buildPath, 'public'),
+            })
+          } catch (err) {
+            console.error('[@ossy/app][dev] Prerender failed', err)
+          }
+        }
         scheduleRestart()
       }
     })

package/cli/prerender-react.task.js

@@ -0,0 +1,270 @@
+import path from 'path'
+import url from 'url'
+import fs from 'fs'
+import { rollup } from 'rollup'
+import { BuildPage } from './render-page.task.js'
+
+/**
+ * Maps an app route path to the file path express.static will serve for that URL
+ * (`/` → `public/index.html`, `/a/b` → `public/a/b/index.html`).
+ */
+export function staticHtmlPathForRoute (routePath, publicDir) {
+  const p = typeof routePath === 'string' ? routePath : '/'
+  if (p === '/' || p === '') {
+    return path.join(publicDir, 'index.html')
+  }
+  const segments = p.replace(/^\//, '').split('/').filter(Boolean)
+  return path.join(publicDir, ...segments, 'index.html')
+}
+
+function pathIsPrerenderable (routePath) {
+  if (typeof routePath !== 'string') return false
+  if (!routePath.startsWith('/') || routePath.includes(':')) return false
+  return true
+}
+
+/** Mirrors server-era app shell config with static defaults (no cookies / session). */
+export function buildPrerenderAppConfig ({
+  buildTimeConfig,
+  pageList,
+  activeRouteId,
+  urlPath,
+}) {
+  const pages = pageList.map((page) => {
+    const entry = {
+      id: page?.id,
+      path: page?.path,
+    }
+    if (activeRouteId != null && page?.id === activeRouteId) {
+      entry.element = page?.element
+    }
+    return entry
+  })
+  return {
+    ...buildTimeConfig,
+    url: urlPath,
+    theme: buildTimeConfig.theme || 'light',
+    isAuthenticated: false,
+    workspaceId: buildTimeConfig.workspaceId,
+    apiUrl: buildTimeConfig.apiUrl,
+    pages,
+    sidebarPrimaryCollapsed: false,
+  }
+}
+
+function copyPublicToBuild ({ copyPublicFrom, buildPath }) {
+  if (!copyPublicFrom || !fs.existsSync(copyPublicFrom)) return
+  const dest = path.join(buildPath, 'public')
+  fs.mkdirSync(dest, { recursive: true })
+  fs.cpSync(copyPublicFrom, dest, { recursive: true })
+}
+
+function countSettledFailures (results) {
+  return results.filter((r) => r.status === 'rejected').length
+}
+
+async function bundleOneHydratePage ({
+  entryName,
+  stubPath,
+  buildPath,
+  plugins,
+  minifyPlugin,
+}) {
+  const bundle = await rollup({
+    input: { [entryName]: stubPath },
+    plugins,
+  })
+  try {
+    await bundle.write({
+      dir: buildPath,
+      format: 'esm',
+      inlineDynamicImports: true,
+      entryFileNames (chunkInfo) {
+        const n = chunkInfo.name
+        if (n.startsWith('hydrate__')) {
+          const pageId = n.slice('hydrate__'.length)
+          return `public/static/hydrate-${pageId}.js`
+        }
+        return 'public/static/[name].js'
+      },
+      chunkFileNames: 'public/static/[name]-[hash].js',
+      plugins: minifyPlugin ? [minifyPlugin] : [],
+    })
+  } finally {
+    await bundle.close()
+  }
+}
+
+async function bundleHydratePagesParallel ({
+  clientHydrateInput,
+  buildPath,
+  copyPublicFrom,
+  nodeEnv,
+  buildPathForPlugins,
+  createClientRollupPlugins,
+  minifyBrowserStaticChunks,
+}) {
+  copyPublicToBuild({ copyPublicFrom, buildPath })
+  fs.mkdirSync(path.join(buildPath, 'public', 'static'), { recursive: true })
+
+  const entries = Object.entries(clientHydrateInput)
+
+  const results = await Promise.allSettled(
+    entries.map(([entryName, stubPath]) => {
+      const plugins = createClientRollupPlugins({
+        nodeEnv,
+        copyPublicFrom: undefined,
+        buildPath: buildPathForPlugins,
+      })
+      return bundleOneHydratePage({
+        entryName,
+        stubPath,
+        buildPath,
+        plugins,
+        minifyPlugin: minifyBrowserStaticChunks(),
+      })
+    })
+  )
+
+  const failures = countSettledFailures(results)
+  results.forEach((r, i) => {
+    if (r.status === 'rejected') {
+      const [entryName] = entries[i]
+      console.error(`[@ossy/app][client-bundle] ${entryName} failed:`, r.reason)
+    }
+  })
+
+  return { results, failures }
+}
+
+async function prerenderOnePage ({
+  route,
+  buildTimeConfig,
+  pageList,
+  publicDir,
+}) {
+  const appConfig = buildPrerenderAppConfig({
+    buildTimeConfig,
+    pageList,
+    activeRouteId: route.id,
+    urlPath: route.path,
+  })
+  const html = await BuildPage.handle({
+    route,
+    appConfig,
+    isDevReloadEnabled: false,
+  })
+  const outPath = staticHtmlPathForRoute(route.path, publicDir)
+  fs.mkdirSync(path.dirname(outPath), { recursive: true })
+  fs.writeFileSync(outPath, html, 'utf8')
+  console.log(
+    `[@ossy/app][prerender] ${route.path} → ${path.relative(process.cwd(), outPath)}`
+  )
+}
+
+async function prerenderPagesParallel ({
+  pagesBundlePath,
+  configSourcePath,
+  publicDir,
+}) {
+  const cfgHref = url.pathToFileURL(path.resolve(configSourcePath)).href
+  const pagesHref = url.pathToFileURL(path.resolve(pagesBundlePath)).href
+
+  const configModule = await import(cfgHref)
+  const pagesModule = await import(pagesHref)
+
+  const buildTimeConfig = configModule?.default ?? configModule ?? {}
+  const pageList = pagesModule?.default ?? []
+
+  const routesToRender = []
+  for (const route of pageList) {
+    if (!route?.element) continue
+    if (!pathIsPrerenderable(route.path)) {
+      console.warn(
+        `[@ossy/app][prerender] Skipping "${route.id}" (path not prerenderable: ${JSON.stringify(route.path)})`
+      )
+      continue
+    }
+    routesToRender.push(route)
+  }
+
+  const results = await Promise.allSettled(
+    routesToRender.map((route) =>
+      prerenderOnePage({
+        route,
+        buildTimeConfig,
+        pageList,
+        publicDir,
+      })
+    )
+  )
+  const failures = countSettledFailures(results)
+  results.forEach((r, i) => {
+    if (r.status === 'rejected') {
+      const route = routesToRender[i]
+      console.error(
+        `[@ossy/app][prerender] "${route?.id}" (${route?.path}) failed:`,
+        r.reason
+      )
+    }
+  })
+
+  return { results, failures }
+}
+
+async function runProduction ({
+  clientHydrateInput,
+  pageFilesLength,
+  copyPublicFrom,
+  buildPath,
+  nodeEnv,
+  pagesBundlePath,
+  configSourcePath,
+  createClientRollupPlugins,
+  minifyBrowserStaticChunks,
+}) {
+  if (pageFilesLength === 0 || Object.keys(clientHydrateInput).length === 0) {
+    return { bundleFailures: 0, prerenderFailures: 0 }
+  }
+
+  const { failures: bundleFailures } = await bundleHydratePagesParallel({
+    clientHydrateInput,
+    buildPath,
+    copyPublicFrom,
+    nodeEnv,
+    buildPathForPlugins: buildPath,
+    createClientRollupPlugins,
+    minifyBrowserStaticChunks,
+  })
+
+  const { failures: prerenderFailures } = await prerenderPagesParallel({
+    pagesBundlePath,
+    configSourcePath,
+    publicDir: path.join(buildPath, 'public'),
+  })
+
+  if (bundleFailures + prerenderFailures > 0) {
+    console.warn(
+      `[@ossy/app][build] Finished with ${bundleFailures} client bundle error(s) and ${prerenderFailures} prerender error(s)`
+    )
+  }
+
+  return { bundleFailures, prerenderFailures }
+}
+
+export default {
+  type: '@ossy/app/prerender-react',
+  /** `input.op`: `runProduction` | `prerenderPagesParallel` (see callers in `build.js` / `dev.js`). */
+  async handler (input) {
+    const op = input?.op
+    if (op === 'runProduction') {
+      return runProduction(input)
+    }
+    if (op === 'prerenderPagesParallel') {
+      return prerenderPagesParallel(input)
+    }
+    throw new Error(
+      `[@ossy/app][prerender-react] Unknown op: ${String(op)} (expected runProduction | prerenderPagesParallel)`
+    )
+  },
+}

package/cli/server.js

@@ -5,18 +5,12 @@ import morgan from 'morgan'
 import { Router as OssyRouter } from '@ossy/router'
 import { ProxyInternal } from './proxy-internal.js'
 import cookieParser from 'cookie-parser'
-import { BuildPage } from './render-page.task.js'
 
-import pages from './.ossy/pages.bundle.js'
 import ApiRoutes from './.ossy/api.bundle.js'
 import Middleware from './.ossy/middleware.runtime.js'
-import configModule from './.ossy/config.runtime.js'
-
-const buildTimeConfig = configModule?.default ?? configModule ?? {}
 
 /** API bundle default may be an empty array. */
 const apiRouteList = ApiRoutes ?? []
-const pageList = pages ?? []
 
 const app = express();
 
@@ -108,34 +102,9 @@ const middleware = [
 app.use(middleware)
 
 const Router = OssyRouter.of({
-  pages: [...apiRouteList, ...pageList]
+  pages: apiRouteList,
 })
 
-function resolveAppConfig ({ req, buildTimeConfig, activeRouteId }) {
-  const userAppSettings = req.userAppSettings || {}
-  const pages = pageList.map((page) => {
-    const entry = {
-      id: page?.id,
-      path: page?.path,
-    }
-    if (activeRouteId != null && page?.id === activeRouteId) {
-      entry.element = page?.element
-    }
-    return entry
-  })
-  return {
-    ...buildTimeConfig,
-    url: req.originalUrl,
-    theme: userAppSettings.theme || buildTimeConfig.theme || 'light',
-    isAuthenticated: req.isAuthenticated || false,
-    workspaceId: userAppSettings.workspaceId || buildTimeConfig.workspaceId,
-    apiUrl: buildTimeConfig.apiUrl,
-    pages,
-    /** Primary app shell sidebar: icon rail when true (persisted in `x-ossy-user-settings`). */
-    sidebarPrimaryCollapsed: userAppSettings.sidebarPrimaryCollapsed === true,
-  }
-}
-
 app.all('*all', (req, res) => {
   const pathname = req.originalUrl
 
@@ -147,23 +116,9 @@ app.all('*all', (req, res) => {
     return
   }
 
-  if (!route?.element) {
-    res.status(404).send('Not found')
-    return
-  }
-
-  const appConfig = resolveAppConfig({
-    req,
-    buildTimeConfig,
-    activeRouteId: route.id,
-  })
-
-  BuildPage.handle({ route, appConfig, isDevReloadEnabled })
-    .then(html => { res.send(html) })
-    .catch(err => { res.send(err) })
-
+  res.status(404).send('Not found')
 })
 
 app.listen(port, () => {
   console.log(`[@ossy/app][server] Running on http://localhost:${port}`);
-});
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ossy/app",
-  "version": "1.8.0",
+  "version": "1.10.0",
   "description": "",
   "source": "./src/index.js",
   "main": "./src/index.js",
@@ -27,14 +27,14 @@
     "@babel/eslint-parser": "^7.15.8",
     "@babel/preset-react": "^7.26.3",
     "@babel/register": "^7.25.9",
-    "@ossy/connected-components": "^1.8.0",
-    "@ossy/design-system": "^1.8.0",
-    "@ossy/pages": "^1.8.0",
-    "@ossy/router": "^1.8.0",
-    "@ossy/router-react": "^1.8.0",
-    "@ossy/sdk": "^1.8.0",
-    "@ossy/sdk-react": "^1.8.0",
-    "@ossy/themes": "^1.8.0",
+    "@ossy/connected-components": "^1.10.0",
+    "@ossy/design-system": "^1.10.0",
+    "@ossy/pages": "^1.10.0",
+    "@ossy/router": "^1.10.0",
+    "@ossy/router-react": "^1.10.0",
+    "@ossy/sdk": "^1.10.0",
+    "@ossy/sdk-react": "^1.10.0",
+    "@ossy/themes": "^1.10.0",
     "@rollup/plugin-alias": "^6.0.0",
     "@rollup/plugin-babel": "6.1.0",
     "@rollup/plugin-commonjs": "^29.0.0",
@@ -67,5 +67,5 @@
     "README.md",
     "tsconfig.json"
   ],
-  "gitHead": "4587756b973bce942950c710c7b8a8b0c52a7786"
+  "gitHead": "bd9dfaf87661392562fbe2cdfd3ca6d645147f24"
 }