All files / coherent.js/packages/core/src/utils enhanced-errors.js

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

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 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
/**
 * Enhanced Error System for Coherent.js
 * Provides detailed, actionable error messages to improve developer experience
 */
 
/**
 * Base error class with enhanced messaging
 */
export class CoherentError extends Error {
  constructor(message, options = {}) {
    super(message);
    this.name = this.constructor.name;
    this.code = options.code;
    this.suggestions = options.suggestions || [];
    this.documentation = options.documentation;
    this.context = options.context || {};
    
    // Capture stack trace
    if (Error.captureStackTrace) {
      Error.captureStackTrace(this, this.constructor);
    }
  }
 
  /**
   * Format error message with suggestions
   */
  toString() {
    let output = `${this.name}: ${this.message}`;
    
    if (this.code) {
      output += `\nError Code: ${this.code}`;
    }
    
    if (this.suggestions.length > 0) {
      output += '\n\nšŸ’” Suggestions:';
      this.suggestions.forEach((suggestion, index) => {
        output += `\n  ${index + 1}. ${suggestion}`;
      });
    }
    
    if (this.documentation) {
      output += `\n\nšŸ“š Documentation: ${this.documentation}`;
    }
    
    if (Object.keys(this.context).length > 0) {
      output += '\n\nšŸ” Context:';
      Object.entries(this.context).forEach(([key, value]) => {
        output += `\n  ${key}: ${JSON.stringify(value)}`;
      });
    }
    
    return output;
  }
}
 
/**
 * Component-related errors
 */
export class ComponentError extends CoherentError {
  constructor(message, options = {}) {
    super(message, {
      ...options,
      code: options.code || 'COMPONENT_ERROR',
      documentation: options.documentation || 'https://coherentjs.dev/docs/components'
    });
  }
}
 
/**
 * Invalid component structure error
 */
export function createInvalidComponentError(componentName, issue) {
  const suggestions = [];
  
  if (issue.includes('children')) {
    suggestions.push(
      'Wrap multiple elements in a parent container: { div: { children: [...] } }',
      'Or return an array of elements: [{ h1: {...} }, { p: {...} }]',
      'Check that children is an array, not an object'
    );
  }
  
  if (issue.includes('text') && issue.includes('html')) {
    suggestions.push(
      'Use either "text" or "html" property, not both',
      'Use "text" for safe, escaped content',
      'Use "html" only for trusted HTML content'
    );
  }
  
  if (issue.includes('undefined')) {
    suggestions.push(
      'Ensure all component functions return a valid object or array',
      'Check for missing return statements',
      'Verify that props are being passed correctly'
    );
  }
  
  return new ComponentError(
    `Invalid component structure in "${componentName}": ${issue}`,
    {
      code: 'INVALID_COMPONENT_STRUCTURE',
      suggestions,
      context: { componentName, issue }
    }
  );
}
 
/**
 * Rendering errors
 */
export class RenderError extends CoherentError {
  constructor(message, options = {}) {
    super(message, {
      ...options,
      code: options.code || 'RENDER_ERROR',
      documentation: options.documentation || 'https://coherentjs.dev/docs/rendering'
    });
  }
}
 
/**
 * Create error for invalid element type
 */
export function createInvalidElementError(elementType, validTypes) {
  return new RenderError(
    `Invalid element type: "${elementType}"`,
    {
      code: 'INVALID_ELEMENT_TYPE',
      suggestions: [
        `Valid element types are: ${validTypes.join(', ')}`,
        'Check for typos in element names',
        'Ensure you\'re using lowercase HTML tag names',
        'For custom components, use createComponent() first'
      ],
      context: { elementType, validTypes }
    }
  );
}
 
/**
 * State management errors
 */
export class StateError extends CoherentError {
  constructor(message, options = {}) {
    super(message, {
      ...options,
      code: options.code || 'STATE_ERROR',
      documentation: options.documentation || 'https://coherentjs.dev/docs/state'
    });
  }
}
 
/**
 * Create error for invalid state update
 */
export function createInvalidStateUpdateError(key, value, expectedType) {
  return new StateError(
    `Invalid state update for key "${key}"`,
    {
      code: 'INVALID_STATE_UPDATE',
      suggestions: [
        `Expected type: ${expectedType}, received: ${typeof value}`,
        'Use setState() method to update state',
        'Ensure state updates are serializable',
        'Check that you\'re not mutating state directly'
      ],
      context: { key, value, expectedType, receivedType: typeof value }
    }
  );
}
 
/**
 * Hydration errors
 */
export class HydrationError extends CoherentError {
  constructor(message, options = {}) {
    super(message, {
      ...options,
      code: options.code || 'HYDRATION_ERROR',
      documentation: options.documentation || 'https://coherentjs.dev/docs/hydration'
    });
  }
}
 
/**
 * Create error for hydration mismatch
 */
export function createHydrationMismatchError(expected, actual, path) {
  return new HydrationError(
    `Hydration mismatch at path: ${path}`,
    {
      code: 'HYDRATION_MISMATCH',
      suggestions: [
        'Ensure server and client render the same content',
        'Check for differences in data between SSR and client',
        'Avoid using Date.now() or Math.random() in render functions',
        'Use suppressHydrationWarning prop if mismatch is intentional'
      ],
      context: { expected, actual, path }
    }
  );
}
 
/**
 * Router errors
 */
export class RouterError extends CoherentError {
  constructor(message, options = {}) {
    super(message, {
      ...options,
      code: options.code || 'ROUTER_ERROR',
      documentation: options.documentation || 'https://coherentjs.dev/docs/routing'
    });
  }
}
 
/**
 * Create error for route not found
 */
export function createRouteNotFoundError(path) {
  return new RouterError(
    `Route not found: "${path}"`,
    {
      code: 'ROUTE_NOT_FOUND',
      suggestions: [
        'Check that the route is defined in your router configuration',
        'Verify the path spelling and format',
        'Add a wildcard route (*) to handle 404 pages',
        'Use router.hasRoute() to check if a route exists'
      ],
      context: { path }
    }
  );
}
 
/**
 * Database errors
 */
export class DatabaseError extends CoherentError {
  constructor(message, options = {}) {
    super(message, {
      ...options,
      code: options.code || 'DATABASE_ERROR',
      documentation: options.documentation || 'https://coherentjs.dev/docs/database'
    });
  }
}
 
/**
 * Create error for connection failure
 */
export function createConnectionError(adapter, originalError) {
  return new DatabaseError(
    `Failed to connect to database using ${adapter} adapter`,
    {
      code: 'DATABASE_CONNECTION_FAILED',
      suggestions: [
        'Check your database connection string',
        'Verify that the database server is running',
        'Ensure you have the correct credentials',
        'Check firewall and network settings',
        `Install the ${adapter} driver: npm install ${adapter}`
      ],
      context: { adapter, originalError: originalError.message }
    }
  );
}
 
/**
 * API errors
 */
export class APIError extends CoherentError {
  constructor(message, options = {}) {
    super(message, {
      ...options,
      code: options.code || 'API_ERROR',
      documentation: options.documentation || 'https://coherentjs.dev/docs/api'
    });
  }
}
 
/**
 * Create error for validation failure
 */
export function createValidationError(field, rule, value) {
  return new APIError(
    `Validation failed for field "${field}"`,
    {
      code: 'VALIDATION_FAILED',
      suggestions: [
        `Rule: ${rule}`,
        'Check the API documentation for required field formats',
        'Ensure all required fields are provided',
        'Verify data types match the schema'
      ],
      context: { field, rule, value }
    }
  );
}
 
/**
 * Performance errors
 */
export class PerformanceError extends CoherentError {
  constructor(message, options = {}) {
    super(message, {
      ...options,
      code: options.code || 'PERFORMANCE_ERROR',
      documentation: options.documentation || 'https://coherentjs.dev/docs/performance'
    });
  }
}
 
/**
 * Create error for performance budget exceeded
 */
export function createPerformanceBudgetError(metric, value, budget) {
  return new PerformanceError(
    `Performance budget exceeded for ${metric}`,
    {
      code: 'PERFORMANCE_BUDGET_EXCEEDED',
      suggestions: [
        `Current: ${value}ms, Budget: ${budget}ms`,
        'Use memoization to cache expensive computations',
        'Implement lazy loading for large components',
        'Check for unnecessary re-renders',
        'Use the performance profiler to identify bottlenecks'
      ],
      context: { metric, value, budget, exceeded: value - budget }
    }
  );
}
 
/**
 * Helper to format error with stack trace
 */
export function formatErrorWithStack(error) {
  if (error instanceof CoherentError) {
    return `${error.toString()}\n\nStack Trace:\n${error.stack}`;
  }
  return error.stack || error.message;
}
 
/**
 * Helper to log error with proper formatting
 */
export function logError(error, context = {}) {
  if (typeof console === 'undefined') return;
  
  console.error('āŒ Coherent.js Error\n');
  
  if (error instanceof CoherentError) {
    console.error(error.toString());
  } else {
    console.error(error.message || error);
  }
  
  if (Object.keys(context).length > 0) {
    console.error('\nšŸ” Additional Context:', context);
  }
  
  if (error.stack) {
    console.error('\nšŸ“ Stack Trace:');
    console.error(error.stack);
  }
}
 
/**
 * Export all error creators
 */
export const ErrorCreators = {
  component: {
    invalidStructure: createInvalidComponentError
  },
  render: {
    invalidElement: createInvalidElementError
  },
  state: {
    invalidUpdate: createInvalidStateUpdateError
  },
  hydration: {
    mismatch: createHydrationMismatchError
  },
  router: {
    notFound: createRouteNotFoundError
  },
  database: {
    connection: createConnectionError
  },
  api: {
    validation: createValidationError
  },
  performance: {
    budgetExceeded: createPerformanceBudgetError
  }
};