xxscreeps-mod-client 0.3.6 → 0.3.8

package/backend.js

@@ -58,17 +58,17 @@ function normalizeMount(input) {
 const mountPath = normalizeMount(process.env.SCREEPS_MOD_CLIENT_MOUNT_PATH ?? '/')
 const rootRedirect = readBool('SCREEPS_MOD_CLIENT_ROOT_REDIRECT', mountPath !== '/')
 
-// Paths that should never be handled by the client mod, even when mounted at '/'.
-// Can be overridden via SCREEPS_MOD_CLIENT_EXCLUDE (comma-separated prefixes).
-// Note: /assets/ is reserved by the game server; the client bundle uses /_client/ instead.
-// Do NOT exclude /map/ — it's a client-side SPA route (/map/<shard>). xxscreeps has no
-// HTTP route there (map-stats is under /api/, map render assets under /assets/, the map
-// renderer is a websocket), and the await-next()-then-404-fallback below already leaves
-// any real server route untouched.
-const DEFAULT_EXCLUDES = ['/api/', '/socket', '/backend/', '/auth/', '/assets/']
-const excludePrefixes = process.env.SCREEPS_MOD_CLIENT_EXCLUDE
-  ? process.env.SCREEPS_MOD_CLIENT_EXCLUDE.split(',').map(s => s.trim()).filter(Boolean)
-  : DEFAULT_EXCLUDES
+// Top-level client SPA routes. A path that isn't a real file in dist/ but matches
+// one of these is a client-side deep link (or a reload of one) and gets the SPA
+// shell; every other path is handed to xxscreeps, so its API/website routes are
+// never shadowed and genuinely-unknown paths get a real 404 instead of the shell.
+// Mirrors the route table in screeps-client/src/stores/routeStore.ts +
+// utils/gameRoutes.ts — keep in sync when the client gains a new top-level route.
+const SPA_ROUTES = ['/user', '/profile', '/messages', '/market', '/room-overview', '/map', '/room']
+
+function isSpaRoute(relPath) {
+  return SPA_ROUTES.some(prefix => relPath === prefix || relPath.startsWith(prefix + '/'))
+}
 
 function resolveFile(relPath) {
   const rel = relPath.replace(/^\/+/, '')
@@ -90,15 +90,46 @@ function sendFile(ctx, filePath, stat) {
   ctx.body = createReadStream(filePath)
 }
 
-function renderInjectedIndex(filePath) {
+function jsonForScript(value) {
+  return JSON.stringify(value).replace(/</g, '\\u003c')
+}
+
+// The client fetches `/api/version` on load (pre-login and again post-connect) to
+// configure itself: welcome text, shards, history settings, and the auth/feature
+// gates. Since the server already has this on hand when it renders index.html, we
+// prefetch it once in-process and inline it as `window.__SCREEPS_BOOTSTRAP__`, so
+// the embedded client is configured from the first frame with zero round-trips.
+// Cached like the client's own 5-min version cache; failures just omit the global
+// and the client falls back to its normal fetch.
+const VERSION_TTL_MS = 5 * 60_000
+let versionCache = null
+
+async function bootstrapVersion(ctx) {
+  const now = Date.now()
+  if (versionCache && now < versionCache.expires) return versionCache.data
+  try {
+    const origin = `${ctx.protocol}://${ctx.host}`
+    const res = await fetch(`${origin}/api/version`)
+    if (!res.ok) return null
+    const data = await res.json()
+    versionCache = { data, expires: now + VERSION_TTL_MS }
+    return data
+  } catch (err) {
+    console.error('[xxscreeps-mod-client] failed to prefetch /api/version for bootstrap:', err)
+    return null
+  }
+}
+
+function renderInjectedIndex(filePath, version) {
   const mountDisplay = mountPath === '/' ? '/' : mountPath + '/'
   const baseTag = `<base href="${mountDisplay}">`
-  const metadata = JSON.stringify({
+  const metadata = jsonForScript({
     kind: 'xxscreeps-mod',
     packageName: pkg.name,
     version: pkg.version,
-  }).replace(/</g, '\\u003c')
-  const script = `<script>window.__SCREEPS_CLIENT_EMBEDDED__=${metadata}</script>`
+  })
+  const bootstrap = version ? `;window.__SCREEPS_BOOTSTRAP__=${jsonForScript(version)}` : ''
+  const script = `<script>window.__SCREEPS_CLIENT_EMBEDDED__=${metadata}${bootstrap}</script>`
   let html = readFileSync(filePath, 'utf8')
   // Inject base tag first so relative asset URLs resolve from the mount root,
   // not from the current SPA route (e.g. /room/E11N2).
@@ -106,10 +137,11 @@ function renderInjectedIndex(filePath) {
   return html.includes('</head>') ? html.replace('</head>', `${script}</head>`) : html + script
 }
 
-function sendInjectedIndex(ctx) {
+async function sendInjectedIndex(ctx) {
+  const version = await bootstrapVersion(ctx)
   ctx.type = 'text/html'
   ctx.set('Cache-Control', REVALIDATE_CACHE)
-  ctx.body = renderInjectedIndex(indexFile)
+  ctx.body = renderInjectedIndex(indexFile, version)
 }
 
 // Advertise the server's guest/registration/Steam settings at `/api/version` so
@@ -135,9 +167,6 @@ hooks.register('middleware', koa => {
 
   const mountDisplay = mountPath === '/' ? '/' : mountPath + '/'
   console.log(`[xxscreeps-mod-client] serving client at ${mountDisplay} (rootRedirect=${rootRedirect})`)
-  if (mountPath === '/') {
-    console.log(`[xxscreeps-mod-client] excluded prefixes: ${excludePrefixes.join(', ')}`)
-  }
 
   koa.use(async (ctx, next) => {
     if (ctx.method !== 'GET' && ctx.method !== 'HEAD') return next()
@@ -149,8 +178,6 @@ hooks.register('middleware', koa => {
 
     let relPath
     if (mountPath === '/') {
-      // When mounted at root, skip paths that belong to the game server.
-      if (excludePrefixes.some(p => ctx.path.startsWith(p))) return next()
       relPath = ctx.path
     } else if (ctx.path === mountPath || ctx.path === mountPath + '/') {
       relPath = '/'
@@ -161,7 +188,7 @@ hooks.register('middleware', koa => {
     }
 
     if (relPath === '/' || relPath === '/index.html') {
-      sendInjectedIndex(ctx)
+      await sendInjectedIndex(ctx)
       return
     }
 
@@ -172,14 +199,13 @@ hooks.register('middleware', koa => {
       return
     }
 
-    // Otherwise let xxscreeps handle the request. If it 404s and the path
-    // looks like an SPA route (no file extension on the last segment),
-    // fall back to index.html so client-side routing can take over.
-    await next()
-    if (ctx.status !== 404) return
-    const last = relPath.split('/').pop() ?? ''
-    if (last.includes('.')) return
-    ctx.status = 200
-    sendInjectedIndex(ctx)
+    // Not a real file: claim only the client's own SPA routes (deep links and
+    // reloads) with the index shell, and leave every other path to xxscreeps.
+    if (isSpaRoute(relPath)) {
+      await sendInjectedIndex(ctx)
+      return
+    }
+
+    return next()
   })
 })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xxscreeps-mod-client",
-  "version": "0.3.6",
+  "version": "0.3.8",
   "description": "xxscreeps mod that serves the screeps-client and connects it to the same server.",
   "type": "module",
   "xxscreeps": true,
@@ -23,7 +23,7 @@
     "node": ">=20"
   },
   "dependencies": {
-    "screeps-client": "^0.17.0"
+    "screeps-client": "^0.18.0"
   },
   "peerDependencies": {
     "xxscreeps": "*"