Repository navigation
feat: expose thread API for Go-based PHP extensions - #2305
Conversation
|
@dunglas These are the key changes required for: |
dunglas
left a comment
dunglas
left a comment
There was a problem hiding this comment.
LGTM, but could you add some tests please?
| } | ||
|
|
||
| // PHPThread exposes a PHP thread's request context. | ||
| type PHPThread struct { |
There was a problem hiding this comment.
Maybe we could use this new type internally too, for code clarity?
There was a problem hiding this comment.
Agreed. Kept it minimal to avoid a large refactor.
We can definitely take this further. Need to define scope a bit. For example, if you push this deeper I would suggest to consider addressing worker context, at the moment a worker carries a dummy context at boot time.
There's no way to inject persistent context from outside (e.g. middleware-style state that lives across requests on a worker thread). Could look into making PHPThread carry context consistently for both regular and worker threads.
Happy to expand this PR, or follow up in a new one. A context refactor would touch quite a bit more code.
|
Tests added. |
|
Can you rebase please? |
eabdfd2 to
02576d9
Compare
|
@dunglas Done. |
02576d9 to
9cfce15
Compare
|
One extra note. I put the tests in |
|
|
||
| // Thread retrieves a PHP thread by its index. | ||
| // Returns nil and false if the system is not running or no thread exists at the given index. | ||
| func Thread(index int) (*PHPThread, bool) { |
There was a problem hiding this comment.
| func Thread(index int) (*PHPThread, bool) { | |
| func Thread(index uint) (*PHPThread, bool) { |
This would prevent errors when passing a negative number and match the internal C api. WDYT @johanjanssens?
There was a problem hiding this comment.
Something i missed indeed.
Add APIs that enable Go-based PHP extensions to execute on existing FrankenPHP threads and access per-request state: - Thread(index) — retrieves a PHP thread by its index, returning its *http.Request which carries the request context - PHPThread.Pin() — pins a Go object to prevent GC collection - PHPThread.IsRequestDone() — checks if the request has been closed - frankenphp_thread_index() — C function returning the current thread index so C extension methods can call back into Go This makes it possible to build PHP extensions where PHP calls into C, C resolves the current thread index, and Go handles the logic with full access to the request context.
Test Thread(), PHPThread.Pin(), and request handling. Fix nil pointer dereference in Thread() when no request is active or index is out of bounds.
…h the existing static helper
|
Thanks @johanjanssens! |
PR #2305 was written against the pre-atomic isRunning flag and a frankenPHPContext() method on phpThread; both moved before it landed.
commit [52e1932](52e1932) in #2305 removed the duplicate `frankenphp_thread_index` from both `frankenphp.c` and `frankenphp.h`. However, there wasn't actually a duplicate in `frankenphp.h`, so there's no export for [frankenstate](https://github.com/johanjanssens/frankenstate), [frankenasync](https://github.com/johanjanssens/frankenasync) etc to use Also, the `frankenphp_thread_index` that stayed in `frankenphp.c` has `static inline`, whereas the PR originally did not. So, nothing outside that file can call it. This PR makes the changes that #2305 originally intended. Not sure if that conflicts with anything though. --------- Signed-off-by: nickchomey <88559987+nickchomey@users.noreply.github.com>
Add APIs that enable Go-based PHP extensions to execute on existing FrankenPHP threads and access per-request state:
Thread(index): retrieves a PHP thread by its index, returning its *http.Request which carries the request contextPHPThread.Pin(): pins a Go object to prevent GC collectionPHPThread.IsRequestDone(): checks if the request has been closedfrankenphp_thread_index(): C function returning the current thread index so C extension methods can call back into GoThis makes it possible to build PHP extensions where PHP calls into C, C resolves the current thread index, and Go handles the logic with full access to the request context.