Download the PHP package vasco-fund/symfony-firestore-cache-adapter without Composer

Symfony Firestore Cache Adapter

Production-ready Symfony Cache adapter for Google Cloud Firestore. Perfect for Cloud Run, App Engine, and other stateless GCP environments where filesystem cache is not persistent.

Features

• PSR-6 compliant - Implementation of Psr\Cache\CacheItemPoolInterface
• Namespace isolation - Multi-tenant support with cache namespacing
• High performance - Batch operations and optimized Firestore queries
• Cloud Run optimized - Works seamlessly with ephemeral containers
• Flexible client options - Choose between HTTP client (no extensions required) or Google Cloud SDK (better performance)

Installation

Optional: Google Cloud SDK

By default, this adapter uses the Firestore REST API via Symfony HTTP Client, which works out of the box without any PHP extensions.

For better performance, you can optionally install the Google Cloud SDK (requires the grpc PHP extension):

⚠️ You will have to code you own client implementation to use the SDK.

Requirements

• PHP 8.2 or higher
• Symfony 7.4 or 8.x
• Google Cloud Firestore credentials
• Optional: grpc PHP extension (only required if using Google Cloud SDK)

Configuration

The adapter supports two Firestore client implementations:

• HTTP Client (default) - Uses Symfony HTTP Client, no extensions required

Planned improvements:

• Google Cloud SDK - Better performance, requires grpc extension

1. Basic Configuration (HTTP Client - Default)

Which Client Should I Use?

Recommendation: Start with HTTP client. Only switch to SDK if you need the extra performance and can install the grpc extension.

Usage Examples

Basic Cache Operations

Environment Variables

For HTTP Client

Performance Considerations

Storage Costs

• Firestore charges for storage and per document read/write operation
• Use appropriate TTL values to minimize storage
• Consider namespacing for cache isolation

Latency

• Firestore adds network latency (~10-50ms), it should not be used as the main cache backend for application requiring high performance
• Use batch operations when possible (implemented internally)
• Consider longer TTL for frequently accessed data

Best Practices

1. Set appropriate TTL - Don't cache forever
2. Monitor Firestore usage in GCP Console
3. Use namespaces for multi-environment setups

Testing

Run Tests

With Coverage

With mutation Testing

Static Analysis

Code Style

Full Quality Assurance

Firestore Structure

Cache Items Collection

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

• Rémi Janot
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

Roadmap

• [ ] Support for Firestore using gRPC

Alternatives

• Memcached/Redis on GCP - Better performance but requires always-up service
• Symfony's ChainAdapter - Combine Firestore with APCu for local cache

FAQ

Q: Why Firestore instead of Redis/Memcached? A: Firestore is serverless, scales automatically, and works perfectly with Cloud Run's ephemeral containers. No need to manage a separate cache cluster.

Q: What about costs? A: Firestore pricing is per storage size and per operation. With compression and proper TTL, costs are typically $5-20/month for small to medium applications.

Q: Can I use this in production? A: Yes! This adapter is production-ready with comprehensive tests, strict type checking (PHPStan level 9), and follows Symfony best practices.

Q: Does it work with Symfony 6? A: Yes, it supports Symfony 7.4 LTS and Symfony 8.x.

Q: Do I need the grpc extension? A: No! By default, the adapter uses Symfony HTTP Client which requires no extensions. You can optionally use the Google Cloud SDK for better performance if you have the grpc extension installed.

Q: Which client should I use? A: Start with the HTTP client (default) - it's easier to set up and works everywhere. Switch to the SDK client only if you need the extra performance and can install the grpc extension.