Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions .github/workflows/security.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ jobs:
uses: actions/checkout@v4

- name: Initialize CodeQL
uses: github/codeql-action/init@v2
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}

Expand All @@ -92,9 +92,11 @@ jobs:
run: chmod +x gradlew

- name: Build project
run: ./gradlew build
run: |
export GRADLE_OPTS="-Xmx3g"
./gradlew build

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
33 changes: 15 additions & 18 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Planned for Beta

- Redis integration
- Edge cache providers (Cloudflare, AWS CloudFront, Fastly)
- Advanced metrics and monitoring
- Circuit breaker pattern
- Rate limiting
- Batch operations
- Cost tracking
- Web UI for cache management

### Planned for 1.0

- Performance optimizations
- Enterprise features
- Advanced configuration options
- Comprehensive documentation
- Migration tools
## [0.2.0-beta] - 2026-01-12

### Added
- **Redis Integration**: Distributed caching support via `CacheFlowRedisConfiguration`.
- **Edge Cache Orchestration**: Automatic purging of Cloudflare, AWS CloudFront, and Fastly caches.
- **Russian Doll Pattern**: Local → Redis → Edge multi-level cache flow.
- **Advanced Metrics**: Micrometer integration for tracking hits, misses, and evictions per layer.
- **Async Operations**: Non-blocking Edge Cache purges using Kotlin Coroutines.

### Changed
- Refactored `CacheFlowServiceImpl` to support tiered storage.
- Updated `CacheFlowCoreConfiguration` to inject optional Redis and Edge dependencies.

### Fixed
- Improved test stability and added mock-based verification for distributed paths.

## [0.1.0-alpha] - 2024-12-19

Expand Down
31 changes: 12 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Kotlin](https://img.shields.io/badge/Kotlin-1.9.20-blue.svg)](https://kotlinlang.org)
[![Spring Boot](https://img.shields.io/badge/Spring%20Boot-3.2.0-brightgreen.svg)](https://spring.io/projects/spring-boot)
[![Alpha](https://img.shields.io/badge/Status-Alpha-orange.svg)](https://github.com/mmorrison/cacheflow)
[![Beta](https://img.shields.io/badge/Status-Beta-blue.svg)](https://github.com/mmorrison/cacheflow)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

> ⚠️ **Alpha Release** - This is an early alpha version. Features and APIs may change before the stable release.
> ⚠️ **Beta Release** - This project is now in Beta. Core features are implemented and stable, but we are looking for community feedback.

**CacheFlow** makes multi-level caching effortless. Data flows seamlessly through Local → Redis → Edge layers with automatic invalidation and monitoring.

Expand All @@ -20,7 +20,7 @@
- ⚡ **Blazing Fast** - 10x faster than traditional caching
- 🔄 **Auto-Invalidation** - Smart cache invalidation across all layers
- 📊 **Rich Metrics** - Built-in monitoring and observability
- 🌐 **Edge Ready** - Cloudflare, AWS CloudFront, Fastly support (coming soon)
- 🌐 **Edge Ready** - Cloudflare, AWS CloudFront, Fastly support
- 🛡️ **Production Ready** - Rate limiting, circuit breakers, batching

## 🚀 Quick Start
Expand Down Expand Up @@ -150,28 +150,21 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file

## 🗺️ Roadmap

### Alpha (Current)
### Beta (Current)

- [x] Basic in-memory caching
- [x] AOP annotations (@CacheFlow, @CacheFlowEvict)
- [x] SpEL support
- [x] Management endpoints
- [x] Spring Boot auto-configuration

### Beta (Planned)

- [ ] Redis integration
- [ ] Advanced metrics and monitoring
- [ ] Circuit breaker pattern
- [ ] Rate limiting
- [x] Redis integration
- [x] Advanced metrics and monitoring
- [x] Circuit breaker pattern (Edge)
- [x] Rate limiting (Edge)
- [x] Russian Doll Caching logic

### 1.0 (Future)

- [ ] Edge cache providers (Cloudflare, AWS CloudFront, Fastly)
- [ ] Batch operations
- [ ] Cost tracking
- [ ] Batch operations (Core)
- [ ] Cost tracking (Extended)
- [ ] Web UI for cache management
- [ ] Performance optimizations
- [ ] Comprehensive documentation

---

Expand Down
Loading
Loading