feat: framework refactor + decouple from Hyperf#349
feat: framework refactor + decouple from Hyperf#349binaryfire wants to merge 3501 commits intohypervel:0.4from
Conversation
|
@albertcht To illustrate how much easier it will be to keep Hypervel in sync with Laravel after this refactor, I asked Claude how long it would take to merge laravel/framework#58461 (as an example) into this branch. This is what it said: So just 5-10 minutes of work with the help of AI tooling! Merging individual PRs is inefficient - merging releases would be better. I can set up a Discord channel where new releases are automatically posted via webhooks. Maybe someone in your team can be responsible for monitoring that channel's notifications and merging updates ever week or 2? I'll only be 1-2 hours of work once the codebases are 1:1. We should be diligent about staying on top of merging updates. Otherwise we'll end up in in the same as Hyperf - i.e. the codebase being completely out of date with the current Laravel API. |
|
Hi @binaryfire , Thank you for submitting this PR and for the detailed explanation of the refactor. After reading through it, I strongly agree that this is the best long-term direction for Hypervel. Refactoring Hypervel into a standalone framework and striving for 1:1 parity with Laravel will indeed solve the current issues regarding deep coupling with Hyperf, maintenance difficulties, outdated versions, and inefficient AI assistance. While this is a difficult step, it is absolutely necessary for the future of the project. Regarding this refactor and the planning for the v0.4 branch, I have a few thoughts to verify with you:
Thank you again for dedicating so much effort to driving this forward; this is a massive undertaking. Let's move forward gradually on this branch with ongoing Code Reviews. |
|
Hi @albertcht Thanks for the detailed response! I'm glad we're aligned on the direction. Let me address each point:
Let me know your thoughts! |
8cec3bf to
bfffa6f
Compare
|
Hi @albertcht. The All the Laravel tests have been ported over and are passing (the unit tests, as well as the integration tests for MySQL, MariaDB, Postgres and SQLite). I've implemented Context-based coroutine safety, static caching for performance and modernised all the types. The code passes PHPStan level 5. Let me know if there's anything I've missed, if you have any ideas or you have any questions. The other packages aren't ready for review yet - many of them are mid-migration and contain temporary code. So please don't review the others yet :) I'll let you know when each one is ready. A few points:
|
80f3ef2 to
94c115e
Compare
|
@albertcht The following packages are ready for review. I've modernised typing, optimised the code, added more tests (including integration tests) and fixed several bugs.
I've also ported https://github.com/friendsofhyperf/redis-subscriber into the Redis package. The subscription methods were all blocking - now they're coroutine friendly. With the previous implementation, if you wrapped
The approach follows the same pattern suggested in hyperf/hyperf#4775 (https://github.com/mix-php/redis-subscriber, which Deeka ported to https://github.com/friendsofhyperf/components). I.e. a dedicated raw socket connection with This is a good article re: this issue for reference: https://openswoole.com/article/redis-swoole-pubsub |
|
Hi @albertcht! The new This is Swoole-optimised version of Laravel's IoC Container, replacing Hyperf's container. The goal: give Hypervel the complete Laravel container API while maintaining performance parity with Hyperf's container and full coroutine safety for Swoole's long-running process model. Why replace Hyperf's container?Hyperf's container is minimal. It exposes
Also, the API is very different to Laravel's. This makes it difficult to port Laravel code or use Laravel's service provider patterns without shimming everything. The new container closes that gap completely and makes interacting with the container much more familiar to Laravel devs. It also means that our package and test code will be closer to 1:1 with Laravel now. APIThe new container implements the full Laravel container contract:
It also supports closure return-type bindings (register a binding by returning a typed value from a closure, including union types), Key API difference from HyperfLike Hyperf's Auto-singletoned instances are stored in a separate Attribute-based injection16 contextual attributes are included, providing declarative dependency injection:
Example: class OrderService
{
public function __construct(
#[Config('orders.tax_rate')] private float $taxRate,
#[Tag('payment-processors')] private array $processors,
#[Authenticated] private User $user,
) {}
}PerformanceBuild recipe cachingConstructor parameters are analyzed via reflection once per class and cached as Method parameter caching
Reflection caching
Hot-path optimizations
Performance vs HyperfThe singleton cache-hit path does marginally more work than Hyperf's single Coroutine safetyAll per-request state is stored in coroutine-local
Circular dependency detection uses two complementary mechanisms:
All transient Context state is cleaned up in Scoped instance cleanup is handled consistently across all invalidation paths. Tests~220 tests:
Everything passes at PHPStan level 5. Let me know what you think |
src/database/src/Listeners/RegisterConnectionResolverListener.php
Outdated
Show resolved
Hide resolved
Tests Cache::spy() interaction with Cache::memo() (4 methods). Relies on the Cache facade spy() override added earlier.
Top-level parity file testing RedisStore's outward public API through mocks (15 methods). Adapted for Hypervel's operation-class architecture using RedisCacheTestCase helpers. putMany test uses Lua script expectations instead of multi/exec.
Tests cache:forget command with default and specified store, asserting both exit code and output message.
Verifies touch() returns false on NullStore, matching Laravel.
Adds testTouchExtendsTtl, testLocksCanBeFlushed, testOwnerStatusCanBeCheckedAfterRestoringLock, testOtherOwnerDoesNotOwnLockAfterRestore, testRestoringNonExistingLockDoesNotOwnAnything, testCanGetAll, testCanGetAllWhenSerialized.
Adds Postgres/SQLite get and upsert tests, forgetMany, flush, flushLocks, and touch tests with Postgres/SQLite variants. Removes 3 redundant tests now covered by the ported Laravel methods. Adds helper methods for Postgres/SQLite store and mock creation.
Adds testFlushTriggersEvents, testFlushLocksTriggersEvents, testFlushFailureDoesDispatchEvent, testFlushLocksFailureDoesDispatchEvent. Renames testForgetDoesNotTriggerEventOnFailure to testForgetDoesTriggerFailedEventOnFailure (the test body already correctly asserts that KeyForgetFailed IS dispatched). Fixes getRepository() to pass store config for storeName in events.
Adds testTouchExtendsTtl, flushLocks tests (clean, fail, non-existing directory), hasSeparateLockStore tests (true, false-same, false-null), flushLocks exception test, and testItHandlesForgettingNonFlexibleKeys with correct filesystem path assertion.
…erWhenEventsDisabled Tests the build() method and events config flag on CacheManager.
…yTest Adds flushLocks, supportsFlushingLocks, touch (4 TTL variants), withoutOverlapping (4 atomic tests), taggedCacheWorksWithEnumKey, testItThrowsExceptionWhenGettingFloatStringAsInteger, testPutManyHandlesIntegerArrayKeys (null and finite TTL paths), and testTaggedPutManyHandlesIntegerArrayKeys.
Integration tests for file-based cache locks (9 methods). Tests acquire, release, block, concurrent safety, owner tokens, and lock timeout.
Integration tests for null driver locks (2 methods). Verifies locks can always be acquired and block semantics work.
Integration tests for flexible() stale-while-revalidate, database/file flexible key cleanup, enum keys, DateTime rounding (7 methods). Uses LazilyRefreshDatabase for database cache tests.
Comprehensive MemoizedStore integration tests (21 methods). Tests memoization, invalidation, events, scoped instances, lock support, flexible(), and lock restoration. Uses InteractsWithRedis with auto-discovered setUp/tearDown.
Generic Redis lock integration tests (8 methods). Tests acquire/release,
blocking, concurrent safety, owner tokens, separate connection, and lock
restoration through Cache::store('redis')->lock().
Tests lock acquire/release under every phpredis serializer and compression combination (9 methods). Adapted for Hypervel's pool architecture — configures serializer/compression at the connection config level instead of on a live client instance. Removed RequiresPhpExtension attributes that incorrectly check for standalone PHP extensions when the support is compiled into phpredis itself.
Top-level Redis store integration tests (20 methods + 1 skipped). Tests TTL, INF/NaN, zero-TTL expiry, tagged cache operations, stale entries, putMany, flushLocks, hasSeparateLockStore. Removed testPutManyCallsPutWhenClustered (Hypervel's PutMany operation handles cluster mode internally via multi/exec, tested in Redis/Operations/PutManyTest). Removed dead code from permanently skipped testIncrementWithSerializationEnabled.
Tests touch updates TTL, returns false for non-existent items, and returns false for expired items.
Tests touch propagates through all layers, returns false for non-existent keys, and proxy correctly caps TTL.
Adds test for getConnectionName(). Updates acquire() mock expectations from array format ['EX' => 60, 'NX'] to positional args 'EX', 60, 'NX' to match the RedisLock::acquire() fix.
Updates acquire() mock expectation from array format to positional args to match the RedisLock::acquire() fix.
… events workaround - Add testbench/workbench directory reference table - Add "never dismiss issues" rule with prohibited phrases - Remove outdated "Temporary Workarounds (Until illuminate/events Is Ported)" section — illuminate/events is now ported and behavior is identical to Laravel
Extract connection creation, auth, database selection, isQueueingMode, and callFlushdb into a concrete subclass of RedisConnection.
Cluster-specific overrides: scan with node parameter, flushdb iterating all masters, isQueueingMode checking getMode(), masters() public API, defaultNode caching with reset on reconnect.
RedisConnection is now abstract with reconnect() as abstract method. Extracted setOptions() for shared option-setting logic. Removed concrete connection creation methods and callFlushdb (moved to subclasses). RedisPool routes to PhpRedisConnection or PhpRedisClusterConnection based on cluster config.
Redis::isCluster() reads pool config directly, avoiding pool checkout. StoreContext::isCluster() uses the proxy path instead of withConnection. SafeScan uses instanceof PhpRedisClusterConnection and masters() method. Redis facade docblock updated.
Add PhpRedisConnectionStub, PhpRedisClusterConnectionStub, and FakeRedisClusterClient for cluster-specific test support. Delete old RedisConnectionStub.
Replace m::mock(RedisConnection::class) with PhpRedisConnection or PhpRedisClusterConnection throughout all test suites. Remove manual isCluster() mock expectations where the class type now determines it.
Tests for cluster-specific behavior: isCluster, isQueueingMode in atomic and multi modes, flushdb sync/async across masters, scan with default and explicit node, defaultNode caching and reset on reconnect, masters() API.
Hi @albertcht. This isn't ready yet but I'm opening it as a draft so we can begin discussions and code reviews. The goal of this PR is to refactor Hypervel to be a fully standalone framework that is as close to 1:1 parity with Laravel as possible.
Why one large PR
Sorry about the size of this PR. I tried spreading things across multiple branches but it made my work a lot more difficult. This is effectively a framework refactor - the database package is tightly coupled to many other packages (collections, pagination, pool) as well as several support classes, so all these things need to be updated together. Splitting it across branches would mean each branch needs multiple temporary workarounds + would have failing tests until merged together, making review and CI impractical.
A single large, reviewable PR is less risky than a stack of dependent branches that can't pass CI independently.
Reasons for the refactor
1. Outdated Hyperf packages
It's been difficult to migrate existing Laravel projects to Hypervel because Hyperf's database packages are quite outdated. There are almost 100 missing methods, missing traits, it doesn't support nested transactions, there are old Laravel bugs which haven't been fixed (eg. JSON indices aren't handled correctly), coroutine safety issues (eg. model
unguard(),withoutTouching()). Other packages like pagination, collections and support are outdated too.Stringablewas missing a bunch of methods and traits, for example. There are just too many to PR to Hyperf at this point.2. Faster framework development
We need to be able to move quickly and waiting for Hyperf maintainers to merge things adds a lot of friction to framework development. Decoupling means we don't need to work around things like PHP 8.4 compatibility while waiting for it to be added upstream. Hyperf's testing package uses PHPUnit 10 so we can't update to PHPUnit 13 (and Pest 4 in the skeleton) when it releases in a couple of weeks. v13 has the fix that allows
RunTestsInCoroutineto work with newer PHPUnit versions. There are lots of examples like this.3. Parity with Laravel
We need to avoid the same drift from Laravel that's happened with Hyperf since 2019. If we're not proactive with regularly merging Laravel updates every week we'll end up in the same situation. Having a 1:1 directory and code structure to Laravel whenever possible will make this much easier. Especially when using AI tools.
Most importantly, we need to make it easier for Laravel developers to use and contribute to the framework. That means following the same APIs and directory structures and only modifying code when there's a good reason to (coroutine safety, performance, type modernisation etc).
Right now the Hypervel codebase is confusing for both Laravel developers and AI tools:
hypervel/contractspackage, the Hyperf database code is split across 3 packages, the Hyperf pagination package ishyperf/paginatorand nothyperf/pagination)static::registerCallback('creating')vsstatic::creating())ConfigProviderand LaravelServiceProviderpatterns across different packages is confusing for anyone who doesn't know HyperfThis makes it difficult for Laravel developers to port over apps and to contribute to the framework.
4. AI
The above issues mean that AI needs a lot of guidance to understand the Hypervel codebase and generate Hypervel boilerplate. A few examples:
hypervel/contractsfor contracts) and then have to spend a lot of time grepping for things to find them.And so on... This greatly limits the effectiveness of building Hypervel apps with AI. Unfortunately MCP docs servers and CLAUDE.md rules don't solve all these problems - LLMs aren't great at following instructions well and the sheer volume of Laravel data they've trained on means they always default to Laravel-style code. The only solution is 1:1 parity. Small improvements such as adding native type hints are fine - models can solve that kind of thing quickly from exception messages.
What changed so far
New packages
illuminate/databaseportilluminate/collectionsportilluminate/paginationportilluminate/contracts)hyperf/pool)Macroableto a separate package for Laravel parityRemoved Hyperf dependencies so far
Database package
The big task was porting the database package, making it coroutine safe, implementing performance improvements like static caching and modernising the types.
whereLike,whereNot,groupLimit,rawValue,soleValue, JSON operations, etc.Collections package
Contracts package
Support package
hyperf/tappable,hyperf/stringable,hyperf/macroable,hyperf/codecdependenciesStr,Envand helper classes from LaravelHypervel\Contextwrappers (will be portinghyperf/contextsoon)Number::useCurrency()wasn't actually setting the currency)Coroutine safety
withoutEvents(),withoutBroadcasting(),withoutTouching()now use Context instead of static propertiesUnsetContextInTaskWorkerListenerto clear database context in task workersConnection::resetForPool()to prevent state leaks between coroutinesDatabaseTransactionsManagercoroutine-safeBenefits
Testing status so far
What's left (WIP)
The refactor process
Hyperf's Swoole packages like
pool,coroutine,contextandhttp-serverhaven't changed in many years so porting these is straightforward. A lot of the code can be simplified since we don't need SWOW support. And we can still support the ecosystem by contributing any improvements we make back to Hyperf in separate PRs.Eventually I'll refactor the bigger pieces like the container (contextual binding would be nice!) and the config system (completely drop
ConfigProviderand move entirely to service providers). But those will be future PRs. For now the main refactors are the database layer, collections and support classes + the simple Hyperf packages. I'll just port the container and config packages as-is for now.Let me know if you have any feedback, questions or suggestions. I'm happy to make any changes you want. I suggest we just work through this gradually, as an ongoing task over the next month or so. I'll continue working in this branch and ping you each time I add something new.
EDIT: New comments are getting lost in the commit history so linking them here:
Updated
hypervel/contextpackage ready for reviewSee: #349 (comment)
New
hypervel/http-server,hypervel/http&hypervel/routingpackages ready for reviewSee: #349 (comment)
New
hypervel/containerpackage ready for reviewSee: #349 (comment)
New
hypervel/context,hypervel/coordinator,hypervel/coroutine,hypervel/engine,hypervel/pool&hypervel/redispackages ready for reviewSee: #349 (comment)
New
hypervel/databasepackage ready for reviewSee: #349 (comment)