All files / examples advanced-router-features.js

0% Statements 0/301
0% Branches 0/1
0% Functions 0/1
0% Lines 0/301

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
/**
 * Advanced Router Features Demo - Complete Implementation
 * 
 * This example demonstrates all the advanced router features:
 * 1. Route compilation and optimization
 * 2. Route introspection and debugging
 * 3. Conditional middleware execution
 * 4. Route versioning support
 * 5. Performance metrics and monitoring
 */

import { createObjectRouter } from '../src/api/router.js';

// Create router with all advanced features enabled
const router = createObjectRouter({}, {
  enableMetrics: true,
  enableCompilation: true,
  enableVersioning: true,
  defaultVersion: 'v1',
  versionHeader: 'api-version',
  maxCacheSize: 1000
});

// 1. CONDITIONAL MIDDLEWARE EXAMPLES

// Conditional middleware based on request method
router.use({
  condition: { method: 'POST' },
  middleware: async (req, res) => {
    console.log('šŸ”’ POST request security check');
    req.securityChecked = true;
  },
  name: 'post-security'
});

// Conditional middleware based on path pattern
router.use({
  condition: { path: /^\/admin/ },
  middleware: async (req, res) => {
    console.log('šŸ‘‘ Admin route accessed');
    if (!req.headers.authorization) {
      res.writeHead(401, { 'Content-Type': 'application/json' });
      res.end(JSON.stringify({ error: 'Admin access requires authorization' }));
      return true; // Stop execution
    }
    req.isAdmin = true;
  },
  name: 'admin-auth'
});

// Conditional middleware based on custom function
router.use({
  condition: async (req, res) => {
    // Only run during business hours (9 AM - 5 PM)
    const hour = new Date().getHours();
    return hour >= 9 && hour < 17;
  },
  middleware: async (req, res) => {
    console.log('ā° Business hours middleware active');
    req.businessHours = true;
  },
  name: 'business-hours'
});

// 2. VERSIONED ROUTES

// Version 1 API
router.addVersionedRoute('v1', 'GET', '/users', async (req, res) => {
  return {
    version: 'v1',
    users: [
      { id: 1, name: 'John Doe', email: 'john@example.com' }
    ],
    deprecated: true,
    message: 'This API version is deprecated. Please use v2.'
  };
}, { name: 'users-v1' });

// Version 2 API with enhanced data
router.addVersionedRoute('v2', 'GET', '/users', async (req, res) => {
  return {
    version: 'v2',
    users: [
      { 
        id: 1, 
        name: 'John Doe', 
        email: 'john@example.com',
        profile: {
          avatar: 'https://example.com/avatar.jpg',
          bio: 'Software developer'
        },
        createdAt: '2024-01-01T00:00:00Z'
      }
    ],
    pagination: {
      page: 1,
      limit: 10,
      total: 1
    }
  };
}, { name: 'users-v2' });

// Version 3 API with different structure
router.addVersionedRoute('v3', 'GET', '/users', async (req, res) => {
  return {
    version: 'v3',
    data: {
      users: [
        { 
          id: 1, 
          fullName: 'John Doe', 
          contact: { email: 'john@example.com' },
          metadata: {
            avatar: 'https://example.com/avatar.jpg',
            bio: 'Software developer',
            joinDate: '2024-01-01'
          }
        }
      ]
    },
    meta: {
      pagination: { page: 1, limit: 10, total: 1 },
      version: 'v3',
      timestamp: new Date().toISOString()
    }
  };
}, { name: 'users-v3' });

// 3. ADVANCED ROUTE PATTERNS WITH COMPILATION

// Complex parameter constraints
router.addRoute('GET', '/users/:id(\\d+)/posts/:postId(\\d+)', async (req, res) => {
  return {
    userId: parseInt(req.params.id),
    postId: parseInt(req.params.postId),
    post: {
      title: `Post ${req.params.postId} by User ${req.params.id}`,
      content: 'Lorem ipsum...'
    }
  };
}, { name: 'user-post' });

// Optional parameters with constraints
router.addRoute('GET', '/search/:query/:category(\\w+)?', async (req, res) => {
  return {
    query: req.params.query,
    category: req.params.category || 'all',
    results: []
  };
});

// Multi-segment wildcards
router.addRoute('GET', '/files/**', async (req, res) => {
  return {
    filePath: req.params.splat,
    type: 'file',
    exists: true
  };
});

// 4. DEBUGGING AND INTROSPECTION ENDPOINTS

router.addRoute('GET', '/debug/routes', async (req, res) => {
  return {
    routes: router.getRoutes(),
    debugInfo: router.getDebugInfo()
  };
}, { name: 'debug-routes' });

router.addRoute('GET', '/debug/test/:method/:path', async (req, res) => {
  const testResult = router.testRoute(req.params.method, `/${req.params.path}`);
  return {
    testResult,
    compilationStats: router.getCompilationStats()
  };
});

router.addRoute('GET', '/debug/metrics', async (req, res) => {
  return {
    metrics: router.getMetrics(),
    compilationStats: router.getCompilationStats()
  };
}, { name: 'debug-metrics' });

// 5. PERFORMANCE MONITORING ENDPOINTS

router.addRoute('GET', '/health', async (req, res) => {
  const metrics = router.getMetrics();
  const compilationStats = router.getCompilationStats();
  
  return {
    status: 'healthy',
    uptime: process.uptime(),
    memory: process.memoryUsage(),
    performance: {
      totalRequests: metrics.requests,
      averageResponseTime: metrics.averageResponseTime,
      cacheHitRate: metrics.cacheHitRate,
      compilationHitRate: metrics.compilationHitRate,
      errorRate: metrics.errors / metrics.requests * 100
    },
    compilation: {
      enabled: compilationStats.compilationEnabled,
      routesCompiled: `${compilationStats.compiledRoutes}/${compilationStats.totalRoutes}`,
      cacheSize: compilationStats.compilationCacheSize
    },
    versioning: {
      enabled: router.enableVersioning,
      defaultVersion: router.defaultVersion,
      versionRequests: Object.fromEntries(metrics.versionRequests || [])
    }
  };
}, { name: 'health-check' });

// 6. ADMIN ROUTES WITH CONDITIONAL ACCESS

router.group('/admin', [], () => {
  router.addRoute('GET', '/dashboard', async (req, res) => {
    if (!req.isAdmin) {
      res.writeHead(403, { 'Content-Type': 'application/json' });
      res.end(JSON.stringify({ error: 'Admin access required' }));
      return;
    }
    
    return {
      dashboard: 'Admin Dashboard',
      stats: {
        totalRoutes: router.routes.length,
        cacheSize: router.routeCache.size,
        uptime: process.uptime()
      }
    };
  });
  
  router.addRoute('POST', '/cache/clear', async (req, res) => {
    if (!req.isAdmin) {
      res.writeHead(403, { 'Content-Type': 'application/json' });
      res.end(JSON.stringify({ error: 'Admin access required' }));
      return;
    }
    
    router.clearCache();
    router.clearCompilationCache();
    
    return {
      message: 'All caches cleared successfully',
      timestamp: new Date().toISOString()
    };
  });
});

// 7. URL GENERATION EXAMPLES

router.addRoute('GET', '/urls', async (req, res) => {
  return {
    generatedUrls: {
      usersV1: router.url('users-v1'),
      usersV2: router.url('users-v2'),
      usersV3: router.url('users-v3'),
      userPost: router.url('user-post', { id: '123', postId: '456' }),
      healthCheck: router.url('health-check'),
      debugRoutes: router.url('debug-routes')
    }
  };
});

// Create and start server
const server = router.createServer();

const PORT = process.env.PORT || 3002;
server.listen(PORT, () => {
  console.log(`šŸš€ Advanced Router Features Demo running on http://localhost:${PORT}`);
  console.log('\nšŸ“‹ Try these advanced features:');
  console.log('\nšŸ”„ VERSIONING:');
  console.log(`   GET  http://localhost:${PORT}/users                    - Default version (v1)`);
  console.log(`   GET  http://localhost:${PORT}/users -H "api-version: v2" - Version 2 API`);
  console.log(`   GET  http://localhost:${PORT}/users -H "api-version: v3" - Version 3 API`);
  console.log(`   GET  http://localhost:${PORT}/v2/users                 - Version in URL`);
  
  console.log('\nšŸ” DEBUGGING & INTROSPECTION:');
  console.log(`   GET  http://localhost:${PORT}/debug/routes             - All registered routes`);
  console.log(`   GET  http://localhost:${PORT}/debug/test/GET/users     - Test route matching`);
  console.log(`   GET  http://localhost:${PORT}/debug/metrics            - Performance metrics`);
  
  console.log('\n⚔ PERFORMANCE & HEALTH:');
  console.log(`   GET  http://localhost:${PORT}/health                   - Health check with metrics`);
  console.log(`   GET  http://localhost:${PORT}/urls                     - Generated URLs`);
  
  console.log('\nšŸ”’ CONDITIONAL MIDDLEWARE:');
  console.log(`   GET  http://localhost:${PORT}/admin/dashboard          - Admin route (needs auth)`);
  console.log(`   POST http://localhost:${PORT}/admin/cache/clear        - Clear caches (admin)`);
  
  console.log('\nšŸŽÆ ADVANCED PATTERNS:');
  console.log(`   GET  http://localhost:${PORT}/users/123/posts/456      - Parameter constraints`);
  console.log(`   GET  http://localhost:${PORT}/search/javascript/web    - Optional parameters`);
  console.log(`   GET  http://localhost:${PORT}/files/docs/api/guide.md  - Multi-segment wildcards`);
  
  console.log('\nšŸ” Add Authorization header for admin routes: Authorization: Bearer admin-token');
});

export default router;