cloudflare/miniflareArchived
Miniflare
Miniflare is a local simulator and emulator for Cloudflare Workers. It provides a serverless runtime environment on a local machine, allowing for the development and testing of functions and edge APIs without deploying to a production cloud environment.
The project implements a local simulation of edge storage primitives, including key-value stores, object storage, and durable objects. It further enables a local integration test bed where serverless functions are executed within isolated sandboxes.
The toolset covers a broad development surface, including hot-reloading via file-system monitoring, local state persistence for storage bindings, and the management of environment secrets. It also supports automated integration testing with state-isolated containers to prevent data leakage between test cases.
Features
- Edge Function Development Tools - Provides a comprehensive local environment for developing and testing Cloudflare Workers without deploying to the edge.
- Serverless Runtime Emulation - Provides a local emulator for serverless runtimes and edge APIs to enable offline development and testing.
- Serverless Storage Bindings - Simulates serverless storage bindings and relational databases to persist data during local development.
- Edge Data Persistence - Provides a local implementation of SQL, key-value, and object storage to mimic edge data persistence.
- Local Storage Emulators - Simulates cloud-based object storage and key-value stores on a local machine for offline development.
- Event-Driven Route Triggerings - Simulates HTTP requests to trigger application routes from non-HTTP cloud events like scheduled triggers.
- Local Serverless Emulation - Emulates the full serverless stack locally, including execution environments and event-driven triggers.
- Local Serverless Testing - Provides a local runtime environment for testing serverless functions with integrated hot-reloading.
- Local Simulators - Provides a local runtime environment that simulates Cloudflare Workers and associated edge APIs for development.
- Serverless Runtimes - Provides a local environment that mimics serverless APIs and event triggers for offline function debugging.
- Sandboxed Code Execution Environments - Provides isolated runtime environments that implement web standard APIs to mimic a serverless execution context.
- Integration Testing - Enables automated integration testing by executing functions within simulated runtime environments to verify behavior before deployment.
- File Watchers - Monitors source files for changes to automatically restart the execution environment and refresh the loaded code.
- Hot Code Reloading - Updates serverless application logic in a running environment without requiring a full process restart.
- Live Reloading - Automatically updates the simulated runtime in response to source file changes with detailed logging.
- Environment Secret Management - Securely manages environment variables and secrets for serverless functions within the local simulated runtime.
- Environment & Service Secret Loaders - Loads API keys and secrets from environment files and injects them into the simulated runtime configuration.
- Test Data Isolation - Ensures test records are unique and isolated to prevent data contamination between simulated serverless environments.
