feat(agent): add support for PHP 8.2 (#627)

Co-authored-by: ZNeumann <[email protected]>
Co-authored-by: Michal Nowacki <[email protected]>
Co-authored-by: Michael Fulbright <[email protected]>
Co-authored-by: mfulb <[email protected]>

Author: 4 people

.github/workflows/agent-build.yml

@@ -18,12 +18,10 @@ on:
   push:
     branches: 
       - main
-      - 'php8'
       - 'dev'
   pull_request:
     branches: 
       - main
-      - 'php8'
       - 'dev'
 
 jobs:
@@ -38,7 +36,7 @@ jobs:
     strategy:
       matrix:
         os: [linux]
-        php_ver: ['7.0', '7.1-zts', '7.2', '7.3', '7.4', '8.0', '8.0-zts', '8.1', '8.1-zts']
+        php_ver: ['7.0', '7.1-zts', '7.2', '7.3', '7.4', '8.0', '8.0-zts', '8.1', '8.1-zts', '8.2']
         arch: ['x64', 'x86']
         exclude:
         # Excludes PHP 5.x, 7.x on linux 32-bit
@@ -70,6 +68,9 @@ jobs:
         - os: linux
           php_ver: '8.1-zts'
           arch: 'x86'
+        - os: linux
+          php_ver: '8.2'
+          arch: 'x86'
     steps:
       - name: Checkout Repo 
         uses: actions/checkout@v2

.github/workflows/release-build.yml

@@ -16,53 +16,45 @@ on:
   # Run this workflow manually from the Actions tab or using the API
   #
   workflow_dispatch:
+    inputs:
+      build-number:
+        description: 'Build number for agent version'
+        required: true
+        type: string
 
 jobs:
   agent_release:
     env:
-      PHP_VER: ${{ matrix.php_ver }}
-      ARCH: ${{ matrix.arch }}
-      BUILD_TYPE: release
-      OS: ${{ matrix.os }}
-      image_name: ${{ matrix.os }}:${{ matrix.php_ver }}${{ matrix.arch }}
+      IMAGE_NAME: newrelic/nr-php-agent-builder
+      IMAGE_VERSION: v1
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        os: [linux]
-        php_ver: ['8.0-zts']
-        arch: [x64, x86]
+        platform: [gnu, musl]
+        php_ver: ['8.2']
+        arch: [amd64]
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           ref: ${{ github.event.client_payload.ref }}
-      - name: Build Custom Docker Image
-        run: docker build --build-arg ARCH=$ARCH --build-arg PHP_VER=$PHP_VER --build-arg BUILD_TYPE=$BUILD_TYPE -f ./.github/docker/${OS}/${ARCH}/Dockerfile -t $image_name .
-      - name: Build and Test
-        run: docker run --name runtest --workdir /github/workspace --rm -e GITHUB_WORKSPACE -e GITHUB_ENV -v "${GITHUB_WORKSPACE}":"/github/workspace" $image_name
-      - name: Save build artifacts
-        uses: actions/upload-artifact@v2
-        with:
-          name: ${{ matrix.php_ver }}binaries
-          path: releases
-          if-no-files-found: error
-  combine:
-    if: ${{ always() }}
-    runs-on: ubuntu-latest
-    name: Combine artifacts from matrix build
-    needs: agent_release
-    steps:
-      - name: Create directory
-        run: mkdir releases
-      - name: Download to directory
-        uses: actions/download-artifact@v2
+          path: newrelic-php-agent
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
         with:
-          path: releases
-      - run: sudo apt install tree
-      - run: tree
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v2
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build
+        run: >
+          docker run --rm --platform linux/${{matrix.arch}}
+          -v "${GITHUB_WORKSPACE}/newrelic-php-agent":"/usr/local/src/newrelic-php-agent"
+          -e OPTIMIZE=1
+          -e PCRE_STATIC=yes
+          -e BUILD_NUMBER=${{inputs.build-number}}
+          $IMAGE_NAME:agent-builder-php${{matrix.php_ver}}-${{matrix.platform}}-$IMAGE_VERSION release-${{matrix.php_ver}}-gha
+      - name: Save build artifacts
+        uses: actions/upload-artifact@v3
         with:
-          name: $GITHUB_SHA
-          path: releases
+          path: newrelic-php-agent/releases
+          name: release-from-gha
           if-no-files-found: error

Makefile

@@ -15,6 +15,7 @@ GIT   ?= git
 include make/config.mk
 include make/vendor.mk
 include make/version.mk
+include make/php_versions.mk
 
 # Include the secrets file if it exists, but if it doesn't, that's OK too.
 -include make/secrets.mk
@@ -328,7 +329,7 @@ src/newrelic/infinite_tracing/com_newrelic_trace_v1/v1.pb.go: protocol/infinite_
 
 .PHONY: integration
 integration: Makefile daemon lasp-test-all integration-events-limits
-	for PHP in $${PHPS:-8.1 8.0 7.4 7.3 7.2 7.1 7.0 5.6 5.5}; do \
+	for PHP in $(PHP_VERSION_LIST); do \
           echo; echo "# PHP=$${PHP}"; \
 	  env NRLAMP_PHP=$${PHP} bin/integration_runner $(INTEGRATION_ARGS) || exit 1; \
 	  echo "# PHP=$${PHP}"; \
@@ -354,7 +355,7 @@ integration-events-limits: daemon
 	custom_limits_tests[7000]=583; \
 	custom_limits_tests[30000]=2500; \
 	custom_limits_tests[100000]=8333; \
-	for PHP in $${PHPS:-8.1 8.0 7.4 7.3 7.2 7.1 7.0 5.6 5.5}; do \
+	for PHP in $(PHP_VERSION_LIST); do \
           echo; echo "# PHP=$${PHP}"; \
 	      for custom_max in "$${!custom_limits_tests[@]}"; do \
 	          collector_limit=$${custom_limits_tests[$$custom_max]}; \
@@ -367,7 +368,7 @@ integration-events-limits: daemon
 
 	# test for invalid value (-1) and (1000000)
 	# Should use default (30000) for -1 and max (100000) for 1000000
-	for PHP in $${PHPS:-8.1 8.0 7.4 7.3 7.2 7.1 7.0 5.6 5.5}; do \
+	for PHP in $(PHP_VERSION_LIST); do \
 	    env NRLAMP_PHP=$${PHP} bin/integration_runner $(INTEGRATION_ARGS) \
 	        -max_custom_events 100000 \
 	        tests/event_limits/custom/test_custom_events_max_samples_stored_invalid_toolarge_limit.php || exit 1; \
@@ -379,7 +380,7 @@ integration-events-limits: daemon
 
 	# also run a test where limit is set to 0
 	# default value is used
-	for PHP in $${PHPS:-8.1 8.0 7.4 7.3 7.2 7.1 7.0 5.6 5.5}; do \
+	for PHP in $(PHP_VERSION_LIST); do \
 	    env NRLAMP_PHP=$${PHP} bin/integration_runner $(INTEGRATION_ARGS) \
 	        -max_custom_events 0 \
 	        tests/event_limits/custom/test_custom_events_max_samples_stored_0_limit.php || exit 1; \
@@ -388,7 +389,7 @@ integration-events-limits: daemon
 
 	# also run a test where no agent custom event limit is specified and verify
 	# default value is used
-	for PHP in $${PHPS:-8.1 8.0 7.4 7.3 7.2 7.1 7.0 5.6 5.5}; do \
+	for PHP in $(PHP_VERSION_LIST); do \
 	    env NRLAMP_PHP=$${PHP} bin/integration_runner $(INTEGRATION_ARGS) \
 	        -max_custom_events 30000 \
 	        tests/event_limits/custom/test_custom_events_max_samples_stored_not_specified.php || exit 1; \
@@ -454,7 +455,7 @@ lasp-test: daemon
 	if [ ! $(SUITE_LASP) ]; then echo "USAGE: make lasp-test SUITE_LASP=suite-most-secure"; exit 1; fi
 	@if [ "$(LICENSE_lasp_$(subst -,_,$(SUITE_LASP)))" = "" ] ; then echo "Missing license for $(SUITE_LASP)"; exit 1; fi
 	if [ ! -d "tests/lasp/$(SUITE_LASP)" ]; then echo "No such suite in tests/lasp folder"; exit 1; fi
-	@for PHP in $${PHPS:-8.1 8.0 7.4 7.3 7.2 7.1 7.0 5.6 5.5}; do \
+	@for PHP in $(PHP_VERSION_LIST); do \
           echo; echo "# PHP=$${PHP}"; \
           NRLAMP_PHP=$${PHP} bin/integration_runner $(INTEGRATION_ARGS) -loglevel debug \
         -license $(LICENSE_lasp_$(subst -,_,$(SUITE_LASP))) \

agent/newrelic-install.sh

@@ -543,6 +543,7 @@ add_to_path /usr/local/php-7.3/bin
 add_to_path /usr/local/php-7.4/bin
 add_to_path /usr/local/php-8.0/bin
 add_to_path /usr/local/php-8.1/bin
+add_to_path /usr/local/php-8.2/bin
 
 add_to_path /opt/local/bin
 add_to_path /usr/php/bin
@@ -556,6 +557,7 @@ add_to_path /usr/php-7.3/bin
 add_to_path /usr/php-7.4/bin
 add_to_path /usr/php-8.0/bin
 add_to_path /usr/php-8.1/bin
+add_to_path /usr/php-8.2/bin
 
 add_to_path /usr/php/5.5/bin
 add_to_path /usr/php/5.6/bin
@@ -566,6 +568,7 @@ add_to_path /usr/php/7.3/bin
 add_to_path /usr/php/7.4/bin
 add_to_path /usr/php/8.0/bin
 add_to_path /usr/php/8.1/bin
+add_to_path /usr/php/8.2/bin
 
 add_to_path /opt/php/bin
 add_to_path /opt/zend/bin
@@ -579,6 +582,7 @@ add_to_path /opt/php-7.3/bin
 add_to_path /opt/php-7.4/bin
 add_to_path /opt/php-8.0/bin
 add_to_path /opt/php-8.1/bin
+add_to_path /opt/php-8.2/bin
 
 if [ -n "${NR_INSTALL_PATH}" ]; then
   oIFS="${IFS}"
@@ -1065,6 +1069,10 @@ for this copy of PHP. We apologize for the inconvenience.
       pi_php8="yes"
       ;;
 
+    8.2.*)
+      pi_php8="yes"
+      ;;
+
     *)
       error "unsupported version '${pi_ver}' of PHP found at:
     ${pdir}
@@ -1233,6 +1241,7 @@ does not exist. This particular instance of PHP will be skipped.
     7.4.*)  pi_modver="20190902" ;;
     8.0.*)  pi_modver="20200930" ;;
     8.1.*)  pi_modver="20210902" ;;
+    8.2.*)  pi_modver="20220829" ;;
   esac
   log "${pdir}: pi_modver=${pi_modver}"
 

agent/php_call.c

@@ -15,6 +15,10 @@ zval* nr_php_call_user_func(zval* object_ptr,
                             zend_uint param_count,
                             zval* params[] TSRMLS_DC) {
 #if ZEND_MODULE_API_NO >= ZEND_7_0_X_API_NO /* PHP 7.0+ */
+#if ZEND_MODULE_API_NO >= ZEND_8_2_X_API_NO
+  zend_object* object = NULL;
+  zend_string* method_name = NULL;
+#endif
   int zend_result = FAILURE;
   zval* fname = NULL;
   HashTable* symbol_table = NULL;
@@ -48,8 +52,29 @@ zval* nr_php_call_user_func(zval* object_ptr,
 
   fname = nr_php_zval_alloc();
   nr_php_zval_str(fname, function_name);
-#if ZEND_MODULE_API_NO >= ZEND_8_0_X_API_NO /* PHP 8.0+ */
+#if ZEND_MODULE_API_NO >= ZEND_8_2_X_API_NO /* PHP 8.2+ */
+  /*
+   * With PHP 8.2, functions that do not exist will cause a fatal error to
+   * be thrown. `zend_call_method_if_exists` will attempt to call a function and
+   * silently fail if it does not exist
+   */
+  if (NULL != object_ptr) {
+    object = Z_OBJ_P(object_ptr);
+  } else {
+    object = NULL;
+  }
+
+  if (NULL != fname) {
+    method_name = Z_STR_P(fname);
+  } else {
+    return NULL;
+  }
+
+  zend_result = zend_call_method_if_exists(object, method_name, retval,
+                                           param_count, param_values);
 
+#elif ZEND_MODULE_API_NO < ZEND_8_2_X_API_NO \
+    && ZEND_MODULE_API_NO >= ZEND_8_0_X_API_NO
   /*
    * With PHP8, `call_user_function_ex` was removed and `call_user_function`
    * became the recommended function.

agent/php_includes.h

@@ -52,6 +52,7 @@
 #define ZEND_7_4_X_API_NO 20190902
 #define ZEND_8_0_X_API_NO 20200930
 #define ZEND_8_1_X_API_NO 20210902
+#define ZEND_8_2_X_API_NO 20220829
 
 #if ZEND_MODULE_API_NO >= ZEND_5_6_X_API_NO
 #include "Zend/zend_virtual_cwd.h"

agent/php_nrini.c

@@ -2980,10 +2980,16 @@ STD_PHP_INI_ENTRY_EX("newrelic.application_logging.metrics.enabled",
 PHP_INI_END() /* } */
 
 void nr_php_register_ini_entries(int module_number TSRMLS_DC) {
+#if ZEND_MODULE_API_NO >= ZEND_8_2_X_API_NO
+  int type = MODULE_PERSISTENT;
+#endif
   REGISTER_INI_ENTRIES();
 }
 
 void nr_php_unregister_ini_entries(int module_number TSRMLS_DC) {
+#if ZEND_MODULE_API_NO >= ZEND_8_2_X_API_NO
+  int type = MODULE_PERSISTENT;
+#endif
   UNREGISTER_INI_ENTRIES();
 }
 

agent/tests/tlib_php.c

@@ -301,9 +301,15 @@ nr_status_t tlib_php_engine_create(const char* extra_ini PTSRMLS_DC) {
   /*
    * Actually start the Zend Engine.
    */
+#if ZEND_MODULE_API_NO >= ZEND_8_2_X_API_NO
+  if (FAILURE == php_module_startup(&tlib_module, &newrelic_module_entry)) {
+    return NR_FAILURE;
+  }
+#else
   if (FAILURE == php_module_startup(&tlib_module, &newrelic_module_entry, 1)) {
     return NR_FAILURE;
   }
+#endif
 
   /*
    * As noted above, we now replace the interned string callbacks on PHP

axiom/nr_app_harvest.c

@@ -12,6 +12,25 @@
 #include "nr_app_harvest_private.h"
 #include "util_logging.h"
 
+/*
+ * The build pipeline for PHP 8.2 uses a Debian image that is built on a
+ * version of glibc that contains an newer glibc version symbol for `pow()`
+ * which is incompatible with older distributions, causing RPM installs to fail.
+ *
+ * To pin the version of `pow` to a version compatible with all NR PHP Agent
+ * supported OSes, we utilize `asm()` and `.symver` to instruct the linker to
+ * select an older version of the symbol.
+ */
+#if defined(__GLIBC__)
+#if (((__GLIBC__) > 2) || (((__GLIBC__) == 2) && ((__GLIBC_MINOR__) > 17)))
+#if defined (__x86_64__)
+  __asm__(".symver pow,pow@GLIBC_2.2.5");
+#elif defined (__aarch64__)
+  __asm__(".symver pow,pow@GLIBC_2.17");
+#endif
+#endif
+#endif
+
 void nr_app_harvest_init(nr_app_harvest_t* ah,
                          nrtime_t connect_timestamp,
                          nrtime_t harvest_frequency,

files/Dockerfile

@@ -9,7 +9,7 @@
 
 ARG PHP_VER
 
-FROM php:${PHP_VER:-8.0}
+FROM php:${PHP_VER:-8.2}
 
 RUN docker-php-source extract
 

make/php_versions.mk

@@ -0,0 +1,6 @@
+#
+# Copyright 2023 New Relic Corporation. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+PHP_VERSION_LIST=$${PHPS:-8.2 8.1 8.0 7.4 7.3 7.2 7.1 7.0 5.6 5.5}

make/release.mk

@@ -10,6 +10,8 @@
 # the top-level of the project.
 #
 
+include make/php_versions.mk
+
 RELEASE_OS := $(shell uname -s | tr '[:upper:]' '[:lower:]')
 RELEASE_OS := $(RELEASE_OS:darwin=osx)
 RELEASE_OS := $(RELEASE_OS:sunos=solaris)
@@ -40,17 +42,15 @@ ifeq (osx,$(RELEASE_OS))
   endif
 endif
 
-# Set the default PHP versions we will build.
-PHPS?=8.1 8.0 7.4 7.3 7.2 7.1 7.0 5.6 5.5
 # Set the PHP versions we support on 64-bit OSs.
-SUPPORTED_64=8.1 8.0 7.4 7.3 7.2 7.1 7.0 5.6 5.5
+SUPPORTED_64=$(PHP_VERSION_LIST)
 # Set the PHP versions we support on 32-bit OSs.
 SUPPORTED_32=
 # Of the PHP versions we want to build, determine which are supported on the detected OS.
 ifeq (x64,$(ARCH))
-  SUPPORTED_PHP = $(filter $(SUPPORTED_64),$(PHPS))
+  SUPPORTED_PHP = $(filter $(SUPPORTED_64),$(PHP_VERSION_LIST))
 else
-  SUPPORTED_PHP = $(filter $(SUPPORTED_32),$(PHPS))
+  SUPPORTED_PHP = $(filter $(SUPPORTED_32),$(PHP_VERSION_LIST))
 endif
 
 
@@ -144,6 +144,7 @@ release-$1-zts: Makefile agent | releases/$$(RELEASE_OS)/agent/$$(RELEASE_ARCH)/
 
 endef
 
+$(eval $(call RELEASE_AGENT_TARGET,8.2,20220829))
 $(eval $(call RELEASE_AGENT_TARGET,8.1,20210902))
 $(eval $(call RELEASE_AGENT_TARGET,8.0,20200930))
 $(eval $(call RELEASE_AGENT_TARGET,7.4,20190902))