fix: keep custom extensions registered after worker reload

Author: ousamabenyounes

cli.go

@@ -4,11 +4,15 @@ package frankenphp
 import "C"
 import "unsafe"
 
+const cliFailureExitCode = 1
+
 // ExecuteScriptCLI executes the PHP script passed as parameter.
 // It returns the exit status code of the script.
 func ExecuteScriptCLI(script string, args []string) int {
 	// Ensure extensions are registered before CLI execution
-	registerExtensions()
+	if registerExtensions() != nil {
+		return cliFailureExitCode
+	}
 
 	cScript := C.CString(script)
 	defer C.free(unsafe.Pointer(cScript))
@@ -21,7 +25,9 @@ func ExecuteScriptCLI(script string, args []string) int {
 
 func ExecutePHPCode(phpCode string) int {
 	// Ensure extensions are registered before CLI execution
-	registerExtensions()
+	if registerExtensions() != nil {
+		return cliFailureExitCode
+	}
 
 	cCode := C.CString(phpCode)
 	defer C.free(unsafe.Pointer(cCode))

ext.go

@@ -3,27 +3,37 @@ package frankenphp
 // #include "frankenphp.h"
 import "C"
 import (
+	"errors"
 	"sync"
 	"unsafe"
 )
 
 var (
 	extensions   []*C.zend_module_entry
 	registerOnce sync.Once
+	registerErr  error
+
+	// ErrExtensionRegistration is returned when PHP extension module entries cannot be registered.
+	ErrExtensionRegistration = errors.New("error registering PHP extensions")
 )
 
 // RegisterExtension registers a new PHP extension.
 func RegisterExtension(me unsafe.Pointer) {
 	extensions = append(extensions, (*C.zend_module_entry)(me))
 }
 
-func registerExtensions() {
+func registerExtensions() error {
 	if len(extensions) == 0 {
-		return
+		return nil
 	}
 
 	registerOnce.Do(func() {
-		C.register_extensions((**C.zend_module_entry)(unsafe.Pointer(&extensions[0])), C.int(len(extensions)))
+		if C.register_extensions((**C.zend_module_entry)(unsafe.Pointer(&extensions[0])), C.int(len(extensions))) != C.SUCCESS {
+			registerErr = ErrExtensionRegistration
+			return
+		}
 		extensions = nil
 	})
+
+	return registerErr
 }

frankenphp.c

@@ -26,6 +26,7 @@
 #include <stdint.h>
 #include <stdio.h>
 #include <stdlib.h>
+#include <string.h>
 #ifndef PHP_WIN32
 #include <unistd.h>
 #endif
@@ -1945,17 +1946,25 @@ int register_internal_extensions(void) {
     }
   }
 
-  modules = NULL;
-  modules_len = 0;
-
   return SUCCESS;
 }
 
-void register_extensions(zend_module_entry **m, int len) {
-  modules = m;
+int register_extensions(zend_module_entry **m, int len) {
+  zend_module_entry **persistent_modules =
+      malloc(sizeof(zend_module_entry *) * len);
+
+  if (persistent_modules == NULL) {
+    return FAILURE;
+  }
+
+  memcpy(persistent_modules, m, sizeof(zend_module_entry *) * len);
+
+  modules = persistent_modules;
   modules_len = len;
 
   original_php_register_internal_extensions_func =
       php_register_internal_extensions_func;
   php_register_internal_extensions_func = register_internal_extensions;
+
+  return SUCCESS;
 }

frankenphp.go

@@ -249,7 +249,10 @@ func Init(options ...Option) error {
 	// Docker/Moby has a similar hack: https://github.com/moby/moby/blob/d828b032a87606ae34267e349bf7f7ccb1f6495a/cmd/dockerd/docker.go#L87-L90
 	signal.Ignore(syscall.SIGPIPE)
 
-	registerExtensions()
+	if err := registerExtensions(); err != nil {
+		isRunning = false
+		return err
+	}
 
 	opt := &opt{}
 	for _, o := range options {

frankenphp.h

@@ -228,6 +228,6 @@ size_t frankenphp_get_thread_memory_usage(uintptr_t thread_index);
 void frankenphp_force_kill_thread(force_kill_slot slot);
 void frankenphp_release_thread_for_kill(force_kill_slot slot);
 
-void register_extensions(zend_module_entry **m, int len);
+int register_extensions(zend_module_entry **m, int len);
 
 #endif

internal/testext/exttest.go

@@ -22,6 +22,11 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+const (
+	firstExtensionName  = "ext1"
+	secondExtensionName = "ext2"
+)
+
 func testRegisterExtension(t *testing.T) {
 	frankenphp.RegisterExtension(unsafe.Pointer(&C.module1_entry))
 	frankenphp.RegisterExtension(unsafe.Pointer(&C.module2_entry))
@@ -30,17 +35,27 @@ func testRegisterExtension(t *testing.T) {
 	require.Nil(t, err)
 	defer frankenphp.Shutdown()
 
+	assertRegisteredExtensions(t)
+
+	frankenphp.RestartWorkers()
+
+	assertRegisteredExtensions(t)
+}
+
+func assertRegisteredExtensions(t *testing.T) {
+	t.Helper()
+
 	req := httptest.NewRequest("GET", "http://example.com/index.php", nil)
 	w := httptest.NewRecorder()
 
-	req, err = frankenphp.NewRequestWithContext(req, frankenphp.WithRequestDocumentRoot("./testdata", false))
+	req, err := frankenphp.NewRequestWithContext(req, frankenphp.WithRequestDocumentRoot("./testdata", false))
 	assert.NoError(t, err)
 
 	err = frankenphp.ServeHTTP(w, req)
 	assert.NoError(t, err)
 
 	resp := w.Result()
 	body, _ := io.ReadAll(resp.Body)
-	assert.Contains(t, string(body), "ext1")
-	assert.Contains(t, string(body), "ext2")
+	assert.Contains(t, string(body), firstExtensionName)
+	assert.Contains(t, string(body), secondExtensionName)
 }