@gen3/workspaces 0.12.55 → 0.12.57

package/dist/server/esm/server.js

@@ -35,6 +35,7 @@ const MIME_TYPES = {
     '.map': 'application/json; charset=utf-8',
     '.ipynb': 'application/json; charset=utf-8'
 };
+const DEFAULT_FULL_THEMES_URL = '/workspace-api/workspace-assets/remote/build/themes';
 const REMOTE_DISABLED_EXTENSIONS = [
     '@jupyterlite/services-extension:config-section-manager',
     '@jupyterlite/services-extension:default-drive',
@@ -55,10 +56,26 @@ const ASSETS_ROOT_PATH = process.env.JUPYTER_ASSETS_ROOT_PATH || '/gen3/jupyter-
 function defaultAssetRoot() {
     return ASSETS_ROOT_PATH.startsWith('/') ? ASSETS_ROOT_PATH : nodePath.join(process.cwd(), ASSETS_ROOT_PATH);
 }
+const DEFAULT_REMOTE_BRANDING = {
+    appName: 'JupyterLite',
+    faviconUrl: '/favicon2.ico'
+};
+/** Escape characters that are special inside an HTML text node / attribute. */ function escapeHtml(text) {
+    return text.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#x27;');
+}
+/**
+ * Replace the document title with the configured page title (or app name).
+ * Values originate from a server-side config file, but they are escaped so a
+ * stray `<` in a commons name cannot break out of the title element.
+ */ function replaceTitle(html, branding) {
+    const title = branding.pageTitle ?? branding.appName;
+    if (!title) return html;
+    return html.replace(/<title>[^<]*<\/title>/, `<title>${escapeHtml(title)}</title>`);
+}
 /**
  * Resolve the origin from forwarding headers, with referer fallback.
  * Handles proxies that drop non-standard ports from the Host header.
- */ function resolveOrigin$1(req) {
+ */ function resolveOrigin(req) {
     const forwardedProto = (Array.isArray(req.headers['x-forwarded-proto']) ? req.headers['x-forwarded-proto'][0] : req.headers['x-forwarded-proto']) || 'http';
     const forwardedHost = Array.isArray(req.headers['x-forwarded-host']) ? req.headers['x-forwarded-host'][0] : req.headers['x-forwarded-host'];
     const hostHeader = Array.isArray(req.headers.host) ? req.headers.host[0] : req.headers.host;
@@ -86,11 +103,10 @@ function defaultAssetRoot() {
         host: resolvedHost
     };
 }
-function injectRemoteConfig(html, req, gatewayBaseUrl, disabledExtensions, branding = {
-    appName: 'JupyterLite',
-    faviconUrl: '/favicon2.ico'
-}) {
-    const { proto, host } = resolveOrigin$1(req);
+function injectRemoteConfig(html, req, config) {
+    const { gatewayBaseUrl, disabledExtensions, fullThemesUrl, remoteKernelsPath } = config;
+    const branding = config.branding ?? DEFAULT_REMOTE_BRANDING;
+    const { proto, host } = resolveOrigin(req);
     const absoluteGatewayBase = `${proto}://${host}${gatewayBaseUrl}`;
     // Inject server-side JEG token — overrides any client-supplied auth header.
     // This ensures calls from JupyterLite's own serverconnection.js are also authenticated.
@@ -104,14 +120,20 @@ function injectRemoteConfig(html, req, gatewayBaseUrl, disabledExtensions, brand
         remoteBaseUrl: absoluteGatewayBase,
         remoteToken: accessToken,
         disabledExtensions,
-        fullThemesUrl: '/workspace-api/workspace-assets/remote/build/themes',
+        fullThemesUrl,
         // Required so JupyterLab sets window.jupyterapp, which the parent
         // frame uses for polling readiness and attaching remote kernels.
         exposeAppInBrowser: 'true'
     };
+    if (remoteKernelsPath) {
+        // Absolute so JupyterLite does not resolve kernel ops relative to
+        // /workspace-api/workspace-assets/remote/. Routing all kernel traffic
+        // through jeg-proxy lets JupyterLite see merged container + JEG kernelspecs.
+        configData.remoteKernelsBaseUrl = `${proto}://${host}${remoteKernelsPath}`;
+    }
     if (branding?.appName) configData.appName = branding.appName;
     if (branding?.faviconUrl) configData.faviconUrl = branding.faviconUrl;
-    let result = html.replace(/(<script\s+id="jupyter-config-data"[^>]*>)\s*(\{[^]*?\})\s*(<\/script>)/, (_match, openTag, existingJson, closeTag)=>{
+    const result = html.replace(/(<script\s+id="jupyter-config-data"[^>]*>)\s*(\{[^]*?\})\s*(<\/script>)/, (_match, openTag, existingJson, closeTag)=>{
         let existing = {};
         try {
             existing = JSON.parse(existingJson);
@@ -133,13 +155,10 @@ function injectRemoteConfig(html, req, gatewayBaseUrl, disabledExtensions, brand
         }
         return `${openTag}${JSON.stringify(merged)}${closeTag}`;
     });
-    if (branding?.appName) {
-        result = result.replace(/<title>[^<]*<\/title>/, `<title>${branding.appName}</title>`);
-    }
-    return result;
+    return replaceTitle(result, branding);
 }
 function injectBranding(html, branding) {
-    let result = html.replace(/(<script\s+id="jupyter-config-data"[^>]*>)\s*(\{[^]*?\})\s*(<\/script>)/, (_match, openTag, existingJson, closeTag)=>{
+    const result = html.replace(/(<script\s+id="jupyter-config-data"[^>]*>)\s*(\{[^]*?\})\s*(<\/script>)/, (_match, openTag, existingJson, closeTag)=>{
         let existing = {};
         try {
             existing = JSON.parse(existingJson);
@@ -155,10 +174,7 @@ function injectBranding(html, branding) {
         if (branding.faviconUrl) existing.faviconUrl = branding.faviconUrl;
         return `${openTag}${JSON.stringify(existing)}${closeTag}`;
     });
-    if (branding.appName) {
-        result = result.replace(/<title>[^<]*<\/title>/, `<title>${branding.appName}</title>`);
-    }
-    return result;
+    return replaceTitle(result, branding);
 }
 // ---------- factory ----------
 function createWorkspaceAssetsHandler(options) {
@@ -170,10 +186,18 @@ function createWorkspaceAssetsHandler(options) {
         ...REMOTE_DISABLED_EXTENSIONS,
         ...options.additionalDisabledExtensions
     ] : REMOTE_DISABLED_EXTENSIONS;
-    const branding = options?.appName || options?.faviconUrl ? {
+    const branding = options?.appName || options?.faviconUrl || options?.pageTitle ? {
         appName: options.appName,
-        faviconUrl: options.faviconUrl
+        faviconUrl: options.faviconUrl,
+        pageTitle: options.pageTitle
     } : undefined;
+    const remoteInjectionConfig = {
+        gatewayBaseUrl,
+        disabledExtensions,
+        fullThemesUrl: options?.fullThemesUrl ?? DEFAULT_FULL_THEMES_URL,
+        remoteKernelsPath: options?.remoteKernelsPath,
+        branding
+    };
     // Build the allowed-file sets once at factory time (not per-request) to
     // avoid unbounded I/O on every incoming request (CWE-770).
     const walkDir = (dir, set)=>{
@@ -266,7 +290,7 @@ function createWorkspaceAssetsHandler(options) {
             res.setHeader('Cache-Control', 'no-cache, no-store, must-revalidate');
             try {
                 const html = fs.readFileSync(filePath, 'utf-8');
-                const injected = injectRemoteConfig(html, req, gatewayBaseUrl, disabledExtensions, branding);
+                const injected = injectRemoteConfig(html, req, remoteInjectionConfig);
                 res.status(200).send(injected);
             } catch  {
                 res.status(500).end('Internal server error');
@@ -300,7 +324,6 @@ function createWorkspaceAssetsHandler(options) {
         stream.pipe(res);
     };
 }
-/** Default handler — for one-liner re-exports */ createWorkspaceAssetsHandler();
 
 const DEFAULT_WORKSPACE_ROUTES = [
     '/Workspaces'
@@ -320,7 +343,7 @@ function withJupyterWorkspaces(nextConfig, options) {
         webpack (config, ctx) {
             config.resolve = config.resolve ?? {};
             config.resolve.alias = {
-                ...config.resolve.alias ?? {},
+                ...config.resolve.alias,
                 react: nodePath.dirname(require.resolve('react/package.json')),
                 'react-dom': nodePath.dirname(require.resolve('react-dom/package.json'))
             };
@@ -575,7 +598,7 @@ function filterAndAnnotateSpecs(raw, policy) {
                 display_name: displayNames[specName] ?? rawSpec.spec.display_name,
                 // Inject billing metadata into spec.metadata (available to browser)
                 metadata: {
-                    ...rawSpec.spec.metadata ?? {},
+                    ...rawSpec.spec.metadata,
                     costPerHour: costPerHour[specName] ?? 0,
                     nodeType: nodeType[specName] ?? 'unknown'
                 }
@@ -807,7 +830,7 @@ function resolveKernelRoute(method, actionSegments) {
     const enrichedBody = {
         ...launchBody,
         env: {
-            ...launchBody.env ?? {},
+            ...launchBody.env,
             GEN3_API_KEY_ID: fenceCreds.key_id,
             GEN3_API_KEY_SECRET: fenceCreds.api_key,
             NAMESPACE: process.env.NAMESPACE || 'jupyter-pods',
@@ -1021,125 +1044,112 @@ function createKernelProxyHandler(config) {
     };
 }
 
-const upstreamHandler$2 = createWorkspaceAssetsHandler({
+const CONFIG_ROOT = process.env.GEN3_FRONTEND_CONFIGURATION_ROOT || './config/';
+const CONFIG_FILENAME = 'workspaceAssets.json';
+const DEFAULT_OPTIONS = {
     // Route JupyterLite remote-mode kernel WebSocket traffic through revproxy's
     // /lw-workspace/proxy/ nginx block → ambassador-service (ExternalName → Emissary)
     // → JEG.  Next.js API routes cannot handle WebSocket upgrades, so we must
     // bypass them and use the nginx path that has allow_upgrade + long timeouts.
-    gatewayBaseUrl: '/lw-workspace/proxy/'
-});
-const VECTIS_WORKSPACE_APP_NAME = 'Vectis Workspaces';
-const VECTIS_FAVICON_URL = '/icons/Vectis_Logo_Colored_LightTheme.svg';
-/** Escape characters that are special inside an HTML text node / attribute. */ function escapeHtml(text) {
-    return text.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#x27;');
+    gatewayBaseUrl: '/lw-workspace/proxy/',
+    // Route all kernel ops through jeg-proxy so JupyterLite sees merged Python3
+    // (container) + JEG GPU kernelspecs. The proxy routes Python3 kernel
+    // launches/channels to the container; GPU kernel launches are gated (403)
+    // with a message to use the Kernel Panel.
+    remoteKernelsPath: '/lw-workspace/proxy/jeg-proxy',
+    // The remote tier attaches to a real kernel gateway, so JupyterLite's
+    // in-browser Pyodide kernel must not be offered alongside it.
+    additionalDisabledExtensions: [
+        '@jupyterlite/pyodide-kernel-extension:kernel'
+    ],
+    appName: GEN3_COMMONS_NAME
+};
+const STRING_OPTIONS = [
+    'gatewayBaseUrl',
+    'assetRoot',
+    'appName',
+    'faviconUrl',
+    'pageTitle',
+    'remoteKernelsPath',
+    'fullThemesUrl'
+];
+function configFilePath() {
+    return nodePath.resolve(process.cwd(), CONFIG_ROOT, GEN3_COMMONS_NAME, CONFIG_FILENAME);
 }
 /**
- * Return the first value of a header that Node.js may (in rare edge cases)
- * expose as an array. `host` and `referer` are always strings in practice,
- * but this keeps the helper safe for any header name.
- */ function firstHeader(value) {
-    if (Array.isArray(value)) return value[0];
-    return value;
-}
-function resolveOrigin(req) {
-    const forwardedProto = firstHeader(req.headers['x-forwarded-proto']);
-    const forwardedHost = firstHeader(req.headers['x-forwarded-host']);
-    // `host` is always a single string per Node.js HTTP spec; firstHeader is
-    // used for type-safety only.
-    const hostHeader = firstHeader(req.headers.host);
-    const refererHeader = firstHeader(req.headers.referer);
-    let proto = (forwardedProto ?? '').trim();
-    let host = (forwardedHost || hostHeader || '').trim();
-    if (refererHeader) {
-        try {
-            const refererUrl = new URL(refererHeader);
-            // Prefer referer origin when the host header dropped a non-default port.
-            if (!host || !host.includes(':')) {
-                host = refererUrl.host;
-            }
-            // Only fall back to referer protocol when nothing better is available.
-            if (!proto) {
-                proto = refererUrl.protocol.replace(':', '');
-            }
-        } catch  {
-        // Ignore malformed referer; keep header-derived values.
+ * Pick and type-check the known option keys. Unknown keys are ignored so a
+ * config file can carry extra metadata without reaching the factory,
+ * and a wrong-typed value falls back to its default instead of throwing.
+ */ function parseOptions(raw) {
+    if (typeof raw !== 'object' || raw === null || Array.isArray(raw)) {
+        console.warn(`[workspace-assets] ${CONFIG_FILENAME} is not a JSON object; using defaults.`);
+        return DEFAULT_OPTIONS;
+    }
+    const source = raw;
+    const parsed = {};
+    for (const key of STRING_OPTIONS){
+        const value = source[key];
+        if (value === undefined) continue;
+        if (typeof value === 'string') {
+            parsed[key] = value;
+        } else {
+            console.warn(`[workspace-assets] ignoring ${key}: expected a string, got ${typeof value}.`);
         }
     }
+    const extensions = source.additionalDisabledExtensions;
+    // oxlint-disable-next-line no-console
+    console.log('addtional disabled extensions', source.additionalDisabledExtensions);
+    if (extensions !== undefined) {
+        if (Array.isArray(extensions) && extensions.every((entry)=>typeof entry === 'string')) {
+            parsed.additionalDisabledExtensions = extensions;
+        } else {
+            console.warn('[workspace-assets] ignoring additionalDisabledExtensions: expected an array of strings.');
+        }
+    }
+    // oxlint-disable-next-line no-console
+    console.log('parsed options', parsed);
     return {
-        proto: proto || 'http',
-        host: host || 'localhost:30080'
+        ...DEFAULT_OPTIONS,
+        ...parsed
     };
 }
-function injectVectisBranding(html, req) {
-    const isRemoteTierRequest = (Array.isArray(req.query.tier) ? req.query.tier[0] : req.query.tier) === 'remote';
-    // Resolve origin only when needed (remote tier).
-    const absoluteRemoteBaseUrl = isRemoteTierRequest ? (()=>{
-        const { proto, host } = resolveOrigin(req);
-        return {
-            base: `${proto}://${host}/lw-workspace/proxy/`,
-            proto,
-            host
-        };
-    })() : null;
-    const withConfig = html.replace(/(<script\s+id="jupyter-config-data"[^>]*>)([\s\S]*?)(<\/script>)/, (_match, openTag, rawContent, closeTag)=>{
-        // Strip leading/trailing whitespace left by the template.
-        const trimmed = rawContent.trim();
-        // Verify the captured content looks like a JSON object before parsing.
-        if (!trimmed.startsWith('{') || !trimmed.endsWith('}')) {
-            console.error('[vectis-branding] jupyter-config-data content is not a JSON object; skipping merge.');
-            return _match;
-        }
-        let existing = {};
-        try {
-            existing = JSON.parse(trimmed);
-        } catch (err) {
-            console.error('[vectis-branding] Failed to parse jupyter-config-data JSON; skipping merge.', err);
-            return _match;
-        }
-        const existingDisabled = Array.isArray(existing.disabledExtensions) ? existing.disabledExtensions : [];
-        const remoteDisabledExtensions = isRemoteTierRequest ? [
-            ...existingDisabled,
-            '@jupyterlite/pyodide-kernel-extension:kernel'
-        ] : existingDisabled;
-        const merged = {
-            ...existing,
-            appName: GEN3_COMMONS_NAME,
-            faviconUrl: VECTIS_FAVICON_URL,
-            ...remoteDisabledExtensions.length > 0 ? {
-                disabledExtensions: Array.from(new Set(remoteDisabledExtensions))
-            } : {},
-            ...isRemoteTierRequest && absoluteRemoteBaseUrl ? {
-                // Use an absolute URL so JupyterLite does not resolve WS endpoints
-                // relative to /workspace-api/workspace-assets/remote/.
-                remoteBaseUrl: absoluteRemoteBaseUrl.base,
-                // Route all kernel ops through jeg-proxy so JupyterLite sees merged
-                // Python3 (container) + JEG GPU kernelspecs. The handler routes
-                // Python3 kernel launches/channels to the container; GPU kernel
-                // launches are gated (403) with a message to use the Kernel Panel.
-                remoteKernelsBaseUrl: `${absoluteRemoteBaseUrl.proto}://${absoluteRemoteBaseUrl.host}/lw-workspace/proxy/jeg-proxy`,
-                fullThemesUrl: '/workspace-api/workspace-assets/remote/build/themes'
-            } : {}
-        };
-        return `${openTag}${JSON.stringify(merged)}${closeTag}`;
-    });
-    // Escape the app name before placing it into the HTML title element.
-    return withConfig.replace(/<title>[^<]*<\/title>/, `<title>${escapeHtml(VECTIS_WORKSPACE_APP_NAME)}</title>`);
+function loadOptions() {
+    const file = configFilePath();
+    try {
+        return parseOptions(JSON.parse(fs.readFileSync(file, 'utf-8')));
+    } catch (err) {
+        const reason = err instanceof Error ? err.message : String(err);
+        console.warn(`[workspace-assets] could not read ${file} (${reason}); using defaults.`);
+        return DEFAULT_OPTIONS;
+    }
 }
-function isHtmlResponse(res) {
-    const contentType = res.getHeader('content-type');
-    if (typeof contentType === 'string') return contentType.includes('text/html');
-    if (Array.isArray(contentType)) return contentType.some((v)=>v.includes('text/html'));
-    return false;
+let upstreamHandler$2;
+let loadedConfigMtimeMs;
+/** mtime of the config file, or undefined when it does not exist. */ function configMtimeMs() {
+    try {
+        return fs.statSync(configFilePath()).mtimeMs;
+    } catch  {
+        return undefined;
+    }
 }
-function handler$3(req, res) {
-    const originalSend = res.send.bind(res);
-    res.send = (body)=>{
-        if (typeof body === 'string' && isHtmlResponse(res) && body.includes('id="jupyter-config-data"') && body.includes('<title>')) {
-            return originalSend(injectVectisBranding(body, req));
+function getUpstreamHandler() {
+    if (process.env.NODE_ENV === 'development') {
+        // Rebuild when the config file changes so edits don't need a dev-server
+        // restart. Only the cheap stat runs per request — the expensive asset walk
+        // happens on the first request and then only after a real config change.
+        const mtimeMs = configMtimeMs();
+        if (upstreamHandler$2 && mtimeMs !== loadedConfigMtimeMs) {
+            upstreamHandler$2 = undefined;
         }
-        return originalSend(body);
-    };
-    return upstreamHandler$2(req, res);
+        loadedConfigMtimeMs = mtimeMs;
+    }
+    if (!upstreamHandler$2) {
+        upstreamHandler$2 = createWorkspaceAssetsHandler(loadOptions());
+    }
+    return upstreamHandler$2;
+}
+function handler$3(req, res) {
+    return getUpstreamHandler()(req, res);
 }
 
 // Allowed path prefixes — keeps proxying scoped to the Jupyter Gateway API surface
@@ -1323,8 +1333,6 @@ const upstreamHandler$1 = createKernelProxyHandler({
     }
 });
 async function handler$1(req, res) {
-    const action = Array.isArray(req.query.action) ? req.query.action : [];
-    action[0] === 'api' && action[1] === 'status';
     try {
         await upstreamHandler$1(req, res);
     } catch (err) {
@@ -1490,6 +1498,7 @@ const upstreamHandler = createHatcheryProxyHandler({
     getToken: (req)=>getAccessToken(req.headers['cookie'] ?? '') ?? null
 });
 async function handler(req, res) {
+    // oxlint-disable-next-line no-unused-vars
     req.query.action?.[0];
     const originalSend = res.send.bind(res);
     res.send = (body)=>{