Automatic route discovery for /schema, /app-config, /modules and fixes

Workflows CDK v0.3.0 - Release Notes

Overview

This release introduces major improvements to the dynamic routing system, enhances error handling and validation, and adds automatic route discovery for schema, app configuration, and module endpoints.

Key Features

Dynamic Routing Enhancements

• Added automatic route discovery and registration for /schema, /app-config, and /modules endpoints
• Improved route path handling with automatic conversion of spaces to underscores in directory paths
• Refactored Router class for streamlined route directory management
• Enhanced route generation with module metadata support
• Added content response methods for more flexible API responses

Validation and Error Handling

• Implemented comprehensive request validation system with JSON parsing and type validation
• Enhanced error logging with improved context handling and structured data
• Refined error responses with environment-aware stack trace inclusion
• Added validation for required fields and data types in request processing

Configuration and Environment Handling

• Updated app configuration endpoint from /app_info to /app-config for improved consistency
• Added support for dynamic environment detection
• Implemented configurable port and debug mode settings
• Enhanced app settings with consolidated configuration objects

Performance and Security

• Enhanced Sentry error tracking with comprehensive event enrichment
• Improved request method and URL information tracking
• Added path parameter extraction for better error traceability
• Implemented query parameter extraction for enhanced debugging

Bug Fixes

• Fixed Response() initialization issues
• Improved error handling to propagate exceptions properly to error handlers
• Enhanced schema route registration with better error handling

Developer Experience

• Simplified response structure by removing redundant status and message fields
• Added methods to create JSON-serializable versions of route listings
• Improved logging with environment-based verbosity
• Enhanced metadata generation for discovered modules

Compatibility

No breaking changes were introduced in this release. All existing applications using Workflows CDK v0.2.x should continue to function without modification.

Installation

pip install workflows-cdk==0.3.0

Upgrading

Update your existing installation:

pip install --upgrade workflows-cdk==0.3.0

Enhanced Error Handling & Response Management

Release v0.2.0 - Enhanced Error Handling & Response Management 🚀

This release focuses on improving error handling, response management, and overall system robustness.

🎯 Key Enhancements

Error Handling & Logging

• Enhanced error handling with detailed stack traces in non-production environments
• Improved Sentry integration with better context capture and error tracking
• Added centralized error logging with full traceback support
• New error types for common scenarios:
  • ManagedError.validation_error()
  • ManagedError.not_found()
  • ManagedError.unauthorized()
  • ManagedError.forbidden()
  • ManagedError.server_error()
  • ManagedError.service_error()

Response Management

• Standardized response formatting for success and error cases
• Automatic metadata enrichment including timestamps and environment info
• Intelligent response data handling with empty field cleanup
• Support for both JSON and plain text error responses

Route Management

• Improved route discovery with better error handling
• Enhanced route registration with automatic wrapping of handlers
• Added support for route-specific configuration options
• New core routes for health checks and application info

Configuration & Logging

• Added YAML-based application configuration
• Enhanced logging configuration with environment awareness
• Improved CORS configuration with flexible origin settings
• Better environment variable handling

🔧 Technical Improvements

• Type hints and validation throughout the codebase
• Better request data handling and validation
• Enhanced security with proper error information masking in production
• Improved module importing and route discovery

📚 Documentation

• Added detailed docstrings for all major components
• Improved code examples in route decorators
• Better type annotations for IDE support

🐛 Bug Fixes

• Fixed route discovery in nested directories
• Improved error handling for malformed requests
• Better cleanup of temporary resources
• Fixed metadata merging in error responses

💥 Breaking Changes

• Changed error response format to be more consistent
• Updated route discovery mechanism
• Modified request validation approach

📦 Dependencies

• Flask 2.0.3 or higher
• Werkzeug 2.2 or higher
• Sentry SDK with Flask integration
• PyYAML 6.0+
• Pydantic 2.0+

For detailed usage instructions, see the README.md

Full Changelog: v0.1.0...v0.2.0

Workflows CDK v0.1.0

Release v0.1.0 - Initial Feature Release

🚀 First feature-complete release of the Workflows CDK

Key Features

• File-based routing system inspired by Next.js
• Automatic route discovery and registration
• Built-in error handling with Sentry integration
• Standardized request/response handling
• Environment-aware configuration
• Type-safe error management
• CORS support out of the box

Core Components

• Router: Automatic route discovery and registration
• Request: Enhanced request handling with data/credentials access
• Response: Standardized response formatting
• ManagedError: Structured error handling with Sentry integration

Breaking Changes

• Initial stable release, establishing API contract

Dependencies

• Flask 2.0.3
• Werkzeug 2.2
• Sentry SDK 2.0.0
• Pydantic 2.0+
• PyYAML 6.0+

For detailed usage instructions, see the README.md

Full Changelog: https://github.com/stacksyncdata/workflows-cdk/commits/v0.1.0