feat: framework refactor + decouple from Hyperf#349
feat: framework refactor + decouple from Hyperf#349binaryfire wants to merge 2797 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
Expand the global PHPUnit subscriber from Mockery-only cleanup to ~65 static state resets covering Context, Container, Eloquent, routing, middleware, pagination, sessions, views, DI/AOP, and more. This runs after every test's tearDown() regardless of base class, preventing state leaks even when individual tests forget to clean up. Fix 6 factory tests that relied on leaked $factoryNameResolver state by making them self-contained with explicit guessFactoryNamesUsing(). Switch RemoveableScoutCollectionTest to ScoutTestCase since it needs a container with Config for Searchable model boot.
Rename generic clear()/reset() methods to flushState() for broad "reset everything" methods, and change clear/reset prefixes to flush for targeted cleanup methods, establishing a consistent convention: - flushState() for "reset all static state on this class" - flushX() for targeted cleanup of specific caches Renames: AspectManager, AstVisitorRegistry, Di\ReflectionManager, Container\ReflectionManager, ServerManager, DotenvManager, StrCache, Scout, SupervisorCommandString, WorkerCommandString → flushState(). BoundMethod → flushMethodRecipeCache(). DatabaseConnectionResolver → flushCachedConnections().
Split AspectCollector::clear() into flushState() (full reset) and forgetAspect() (targeted removal). Rename ClassMapManager::clear() to flushState(). Create ProcessManager::flushState() combining clear() + setRunning(false) into one call. Add new flushState() methods to SchemaBuilder (resets all 3 static defaults), ServiceProvider (resets publishes, publishGroups, and publishableMigrationPaths), and Sanctum (resets callbacks and personalAccessTokenModel). Update subscriber and all test usages.
Create a comprehensive flushState() on Telescope that resets all mutable static properties to their defaults: filters, hooks, tags, hidden headers/parameters, dark theme, started flag, ignored URIs, store, auth callback, watchers, and avatar callback. Replace the scattered property assignments in AfterEachTestSubscriber and FeatureTestCase with a single Telescope::flushState() call.
Align the last remaining reset-prefixed cleanup method with the flushX() convention for targeted cleanup methods.
Add Composer::flushState() replacing the protected reset() method and setBasePath(null) cleanup calls. Add RedirectIfAuthenticated and AuthenticateSession flushState() to subscriber. Reorganize subscriber entries into alphabetical order, removing the grouped comment sections. Remove redundant cleanup calls from Foundation, Testbench, and unit TestCase base classes that are now handled by the subscriber. Keep HandleExceptions::flushState($this) in Foundation TestCase (needs test instance) and add it to tests/TestCase for unit tests that manually create Applications. Remove redundant no-arg call from Testbench TestCase since Foundation's tearDown already handles it.
…teSignature All three have mutable static state ($redirectToCallback, $neverValidate) that can leak between tests. Adding proper reset methods so the global subscriber can clean them up.
…esourceRegistrar Encapsulates all static property resets into class-owned methods instead of manually resetting individual properties in the subscriber. AbstractPaginator resets all 6 static properties including resolvers and default views. ResourceRegistrar resets parameter map, singular flag, and verbs to their declared defaults.
…on from tests Both classes had mutable static state that tests were resetting via reflection. Adding proper flushState() methods and updating tests to use them instead.
- Add Authenticate, AuthenticationException, ValidateSignature, BinaryCodec, ProcessCollector, ApiClient PendingRequest to subscriber - Replace manual paginator resolver resets with flushState() calls - Replace manual ResourceRegistrar property resets with flushState() - Make ApiClient PendingRequest::flushCache() static
- Add flushState() to CallableDispatcher and ControllerDispatcher that flushes both reflection cache and enum cache in one call - Update Router::flushRoutingCaches() to use the new flushState() methods - Add flushEnumCache subscriber entries via the new flushState() calls - Remove redundant tearDown/setUp cleanup from tests where the subscriber already handles the same resets: Di, Container, Routing, Support, Broadcasting, and Foundation tests
…tearDown/setUp Fix subscriber to use PHPUnit's FinishedSubscriber (fires unconditionally) instead of AfterTestMethodFinishedSubscriber (only fires when #[After] hooks exist). Add PropagatedContext::flushState() and Once::flushState() to consolidate resets. Remove redundant cleanup from 65+ test files where the subscriber already handles the same static state resets (Context, Carbon, Container, Facade, Model, etc.).
…ubscriber Add Model::clearBootedModels() and Model::flushCasterCache() to subscriber. Fix observer tests to expect boot dispatch calls instead of relying on leaked booted state. Remove redundant Container/Application::setInstance(null), Carbon::setTestNow(), Context::forget(), RequestContext/ResponseContext::forget(), ProcessCollector/ProcessManager::flushState(), UUID factory restore, and Number::flushState() from ~45 test files across multiple packages.
The testPublishAllWithFlag test was publishing real framework provider configs into workbench/config/ because --all iterates all entries in ServiceProvider::$publishes, not just the test's entries. Snapshot and restore $publishes so only test entries are visible during --all.
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)