Release Notes - v2.8.0 🚀

Major Improvements 🌟

Text Processing & Encoding

• ✨ Fixed UTF-8 encoding issues in summary formatting
• 🔧 Added robust bidirectional Unicode text handling
• 🧹 Improved special character cleanup in formatted summaries
• 🎯 Enhanced markdown header parsing (### now renders correctly)

Caching System

• 🔄 Optimized content caching strategy
• 💾 Implemented separate caching for URL content and plain text
• ⚡ Added cache age tracking and validation
• 📊 Improved cache hit/miss logging
• 🔍 Enhanced cache key generation
• ☁️ Integrated Cloudflare caching for TTS endpoint

API Enhancements

• 🎵 Added TTS (Text-to-Speech) endpoint with Cloudflare optimization
• 🔒 Improved API key handling and validation
• 📈 Enhanced rate limiting configuration
• 🔄 Added version tracking for TTS endpoint

Error Handling & Logging

• 📝 Improved error logging with emoji indicators
• 🐛 Enhanced exception handling in summary generation
• 🔍 Added detailed logging for cache operations
• ⚠️ Better validation error messages

Performance Optimizations

• ⚡ Optimized summary generation process
• 🚀 Improved response time tracking
• 💪 Enhanced memory usage in text processing
• 🔧 Optimized database operations

Technical Details 🛠️

Dependencies

• Updated OpenAI client for TTS support
• Enhanced BeautifulSoup implementation for URL scraping
• Optimized bmemcached usage for caching
• Integrated Cloudflare caching

Configuration

• Added new environment variable: TTS_ENDPOINT_URL
• Enhanced cache configuration options
• Updated API rate limits

Database

• Optimized UserActivity tracking
• Enhanced session management
• Improved data encryption for stored content

Bug Fixes 🔧

• Fixed UTF-8 encoding issues in summary output
• Resolved bidirectional text rendering problems
• Fixed cache key generation edge cases
• Addressed TTS endpoint caching issues with Cloudflare
• Fixed summary formatting inconsistencies

Security Improvements 🔒

• Enhanced API key validation
• Improved data encryption
• Added additional request validation
• Enhanced session security

Breaking Changes ⚠️

None

Upgrade Instructions 📋

Environment Setup

1. Update environment variables to include TTS_ENDPOINT_URL.
2. Ensure all API keys are set in the environment.

Cache Setup

1. Configure Memcached with MEMCACHIER_SERVERS, MEMCACHIER_USERNAME, and MEMCACHIER_PASSWORD.
2. Integrate Cloudflare caching by setting appropriate headers.

Database

1. Run database migrations to update schema.

Dependencies

1. Install required packages:

   pip install -r requirements.txt

2. Ensure bmemcached and flask_migrate are installed.

Contributors 👥

• @sahaib

Next Steps 🎯

• Further optimization of caching strategy
• Enhanced TTS functionality
• Additional AI model support
• Performance monitoring improvements

---

Released on: [28-10-2024]
Previous Version: v2.7.0

v2.7.0

Release Notes

Version 2.7.0 (November 15, 2023)

🌟 New Features

1. Enhanced User Management

   • Implemented a new get_or_create_token endpoint for improved user authentication and management.
   • Added fingerprint-based user tracking for better user identification across sessions.

2. Improved Error Handling

   • Enhanced error logging and handling throughout the application, especially in user management and token generation processes.

3. Database Upgrades

   • Integrated Flask-Migrate for smoother database schema management and migrations.
   • Added new columns to the User model: fingerprint, last_ip, created_at, and last_token_refresh.

4. Security Enhancements

   • Implemented Fernet encryption for sensitive data storage.
   • Added an ENCRYPTION_KEY environment variable for secure data handling.

🛠️ Improvements

1. API Key Validation

   • Added checks to ensure all required API keys (CLAUDE, GEMINI, GPT, MISTRAL) are set in environment variables.

2. Database Configuration

   • Improved database URL handling to support both PostgreSQL and SQLite.
   • Added automatic database URL modification for Heroku PostgreSQL compatibility.

3. Logging Enhancements

   • Implemented more comprehensive logging throughout the application for better debugging and monitoring.

4. Code Refactoring

   • Restructured the User and UserActivity models for improved data management.
   • Optimized the token generation and validation processes.

🐛 Bug Fixes

1. Fixed issues with user creation and retrieval in concurrent scenarios.
2. Resolved potential security vulnerabilities in token handling.

📚 Documentation

• Updated README with detailed setup instructions, including environment variable configuration and database initialization steps.

🔧 DevOps

• Updated requirements.txt to include all necessary dependencies, including Flask-Migrate.
• Modified Procfile to ensure proper application startup on Heroku.

🔜 Coming Soon

• Further optimizations for high-traffic scenarios.

---

For any questions or issues, please open an issue on the GitHub repository.