json-rest-api 1.0.6 → 1.0.8

package/plugins/core/connectors/express-plugin.js

@@ -14,8 +14,8 @@
  * - File upload support with busboy or formidable
  */
 
-import express from 'express';
-import { parseJsonApiQuery } from '../utils/connectors-query-parser.js';
+import { requirePackage } from 'hooked-api';
+import { parseJsonApiQuery } from '../lib/querying-writing/connectors-query-parser.js';
 import { createContext } from './lib/request-helpers.js';
 import { createEnhancedLogger } from '../../../lib/enhanced-logger.js';
 
@@ -24,6 +24,14 @@ export const ExpressPlugin = {
   dependencies: ['rest-api'],
   
   async install({ on, vars, helpers, pluginOptions, log, scopes, api, runHooks, addHook }) {
+    // Dynamic import for Express
+    let express;
+    try {
+      express = (await import('express')).default;
+    } catch (e) {
+      requirePackage('express', 'express', 
+        'Express.js is required for HTTP server functionality. This is a peer dependency.');
+    }
     // Enhance the logger
     const enhancedLog = createEnhancedLogger(log, { 
       logFullErrors: true, 
@@ -38,14 +46,17 @@ export const ExpressPlugin = {
     
     const expressOptions = pluginOptions || {};
     
-    const basePath = expressOptions.basePath || '';
+    // Get mountPath from options (this is now a transport concern)
+    const mountPath = expressOptions.mountPath || '';
+    const basePath = mountPath; // Keep basePath for internal use
     const strictContentType = expressOptions.strictContentType !== false;
     const requestSizeLimit = expressOptions.requestSizeLimit || '1mb';
     
     // Set transport information for other plugins
     vars.transport = {
       type: 'express',
-      matchAll: '*' // Express wildcard pattern for matching all routes
+      matchAll: '*', // Express wildcard pattern for matching all routes
+      mountPath: mountPath // Transport-specific mount path
     };
     
     // Register file detector if enabled
@@ -102,6 +113,16 @@ export const ExpressPlugin = {
     router.use(async (req, res, next) => {
       const context = createContext(req, res, 'express');
       
+      // Auto-detect publicBaseUrl if not explicitly set
+      if (!vars.publicBaseUrl) {
+        // Use protocol from X-Forwarded-Proto if behind proxy, otherwise req.protocol
+        const protocol = req.get('x-forwarded-proto') || req.protocol || 'http';
+        const host = req.get('x-forwarded-host') || req.get('host');
+        if (host) {
+          vars.publicBaseUrl = `${protocol}://${host}${basePath}`;
+        }
+      }
+      
       // Transport-specific data for hooks
       const transportData = {
         request: {
@@ -260,20 +281,9 @@ export const ExpressPlugin = {
       // Apply any global before middleware
       const beforeMiddleware = expressOptions.middleware?.beforeAll || [];
       
-      // Create the Express route
-      // Special handling for wildcard paths when basePath is set
-      let expressPath;
-      if (path === vars.transport.matchAll && basePath) {
-        // When we have a basePath and a wildcard, we need to use proper Express wildcard syntax
-        expressPath = basePath + '/*';
-      } else {
-        expressPath = basePath + path;
-      }
-      
-      
       try {
       
-        // 1. Extract the handler logic into a shared function to keep it DRY (Don't Repeat Yourself).
+        // Extract the handler logic into a shared function to keep it DRY (Don't Repeat Yourself).
         const expressHandler = async (req, res) => {
           try {
             // Extract request data
@@ -293,10 +303,18 @@ export const ExpressPlugin = {
             let responseStatus = 200;
             if (result && typeof result.statusCode === 'number') {
               responseStatus = result.statusCode;
-            } else if (req.method === 'DELETE' && !result) {
-              responseStatus = 204;
-            } else if (req.method === 'POST') {
+            } else if (req.method === 'POST' && result) {
+              // POST with content returns 201 Created
               responseStatus = 201;
+            } else if (req.method === 'POST' && !result) {
+              // POST without content returns 204 No Content
+              responseStatus = 204;
+            } else if (req.method === 'DELETE') {
+              // DELETE always returns 204 No Content
+              responseStatus = 204;
+            } else if ((req.method === 'PUT' || req.method === 'PATCH') && !result) {
+              // PUT/PATCH return 204 when no content is returned
+              responseStatus = 204;
             }
 
             // Apply headers from the handler result
@@ -318,6 +336,20 @@ export const ExpressPlugin = {
             // Set content type
             res.set('Content-Type', 'application/vnd.api+json');
 
+            // Set Location header for successful POST requests
+            if (req.method === 'POST' && context.id) {
+              // Extract scopeName from the path (e.g., /api/countries -> countries)
+              const pathParts = path.split('/');
+              const scopeName = pathParts[pathParts.length - 1];
+              
+              // Set Location header for any successful POST (201 or 204)
+              if (helpers.getLocation) {
+                const location = helpers.getLocation({ scopeName, id: context.id });
+                const baseUrl = vars.publicBaseUrl || basePath;
+                res.set('Location', `${baseUrl}${location}`);
+              }
+            }
+
             // Handle response based on status
             if (responseStatus === 204) {
               res.sendStatus(204);
@@ -325,12 +357,6 @@ export const ExpressPlugin = {
               // If result has a body property, that's what we should send
               // This happens when handler returns { statusCode, body, headers }
               const responseBody = result && result.body !== undefined ? result.body : result;
-              
-              if (req.method === 'POST' && responseBody?.data?.id && helpers.getLocation) {
-                const scopeName = path.split('/')[2];
-                const location = helpers.getLocation({ scopeName, id: responseBody.data.id });
-                res.set('Location', `${basePath}/api${location}`);
-              }
               res.status(responseStatus).json(responseBody);
             }
           } catch (error) {
@@ -338,35 +364,75 @@ export const ExpressPlugin = {
           }
         };
 
-        // 2. Check for the wildcard path and use the appropriate Express method.
+        // CRITICAL: Express routing method selection - wildcard vs specific routes
+        // 
+        // Express provides two different ways to register routes:
+        // 1. router.METHOD(path, handler) - e.g., router.get('/users', handler)
+        //    - Only responds to the SPECIFIC HTTP method
+        //    - Perfect for normal REST endpoints
+        // 
+        // 2. router.use(path, handler) 
+        //    - Responds to ALL HTTP methods
+        //    - Needed for wildcard paths that must handle any method
+        //
+        // The CORS plugin needs wildcard routes because it must handle OPTIONS 
+        // requests for ANY path under the API prefix, even paths that don't exist
+        // as defined routes. For example:
+        // - Defined route: GET /api/users
+        // - Browser might send: OPTIONS /api/users/invalid/path
+        // - CORS must still respond with proper headers
+        //
         if (path === vars.transport.matchAll) {
-          // For wildcard paths in Express 5, we need to use middleware approach
-          // Create a middleware that only responds to the specific method
+          // This is a wildcard route (path = '*')
+          // We MUST use router.use() because:
+          // - We need to catch ALL paths (using '*' or '/api/*')
+          // - We need to handle a SPECIFIC method (e.g., OPTIONS)
+          // - router.options('*') would NOT work for paths like '/api/some/nested/path'
+          
+
+          // Since router.use() responds to ALL methods, we need a wrapper
+          // that only handles our specific method (e.g., OPTIONS)
           const methodSpecificMiddleware = (req, res, next) => {
             if (req.method.toLowerCase() === method.toLowerCase()) {
               expressHandler(req, res);
             } else {
+              // Not our method, pass to next middleware
               next();
             }
           };
+          // IMPORTANT: We do NOT need to pass a path to router.use() here!
+          // When no path is provided, router.use() matches ALL requests
+          // This is exactly what we want for wildcard routes
           router.use(...beforeMiddleware, methodSpecificMiddleware);
         } else {
-          // Use the specific method (get, post, all, etc.) for all other defined routes
-          router[method.toLowerCase()](expressPath, ...beforeMiddleware, expressHandler);
+          // This is a normal route with a specific path (e.g., '/api/users')
+          // We use router.METHOD() because:
+          // - We want to respond to ONLY this specific HTTP method
+          // - The path is exact, not a wildcard
+          // - This is more efficient than router.use() with method checking
+          //
+          // Note: Routes from RestApiPlugin already include the full path with mountPath
+          // So we use them as-is without adding basePath to avoid double-prefixing
+
+          router[method.toLowerCase()](path, ...beforeMiddleware, expressHandler);
         }
 
 
       } catch (routeError) {
+        console.log('WWWWWWWWWWWWWWTTTTTTTTTTTTFFFFFFFFFFFFFFFFF', context)
         console.log('[EXPRESS DEBUG] Error creating route:', {
           error: routeError.message,
           stack: routeError.stack,
-          path: expressPath,
+          path: path,
           method: method.toLowerCase()
         });
         throw routeError;
       }
       
-      log.trace(`Express route created: ${method} ${expressPath}`);
+      const logPath = path === vars.transport.matchAll 
+        ? '(all paths)'  // router.use() with no path matches everything
+        : path;
+      log.trace(`Express route created: ${method} ${logPath}`);
     });
     
     // Apply global middleware if configured
@@ -381,7 +447,7 @@ export const ExpressPlugin = {
     // Set up 404 handler in separate router (unless disabled)
     if (expressOptions.handle404 !== false) {
       notFoundRouter.use(async (req, res, next) => {
-        if (req.path.startsWith('/api')) {
+        if (basePath && req.path.startsWith(basePath)) {
           // Create minimal context for 404
           const context = createContext(req, res, 'express');
           const transportData = {