refactor package version metric creation

lavarou · lavarou · commit 7106bad07c1a · 2024-09-18T13:47:28.000-04:00
If possible, use version from php_package added to txn-&gt;php_packages without
addional hashmap lookup.
diff --git a/agent/fw_drupal8.c b/agent/fw_drupal8.c
@@ -669,6 +669,7 @@ NR_PHP_WRAPPER_END
 void nr_drupal_version() {
   zval* zval_version = NULL;
   zend_class_entry* class_entry = NULL;
+  nr_php_package_t* p = NULL;
 
   class_entry = nr_php_find_class("drupal");
   if (NULL == class_entry) {
@@ -687,10 +688,10 @@ void nr_drupal_version() {
   if (nr_php_is_zval_valid_string(zval_version)) {
     char* version = Z_STRVAL_P(zval_version);
     if (NRINI(vulnerability_management_package_detection_enabled)) {
-      nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
+      p = nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
     }
-    nr_txn_add_package_major_version_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
-                                                    version, nr_fw_support_add_package_supportability_metric);
+    nr_fw_support_add_package_supportability_metric(
+        NRPRG(txn), PHP_PACKAGE_NAME, version, p);
   }
 
   nr_php_zval_free(&zval_version);
diff --git a/agent/fw_laravel.c b/agent/fw_laravel.c
@@ -949,6 +949,7 @@ NR_PHP_WRAPPER(nr_laravel_application_construct) {
   zval* this_var = nr_php_scope_get(NR_EXECUTE_ORIG_ARGS TSRMLS_CC);
   ;
   char* version = NULL;
+  nr_php_package_t* p = NULL;
 
   NR_UNUSED_SPECIALFN;
   (void)wraprec;
@@ -961,10 +962,10 @@ NR_PHP_WRAPPER(nr_laravel_application_construct) {
 
   if (NRINI(vulnerability_management_package_detection_enabled)) {
     // Add php package to transaction
-    nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
+    p = nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
   }
-  nr_txn_add_package_major_version_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
-                                                  version, nr_fw_support_add_package_supportability_metric);
+  nr_fw_support_add_package_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
+                                                  version, p);
 
   if (version) {
     nrl_debug(NRL_FRAMEWORK, "Laravel version is " NRP_FMT, NRP_PHP(version));
diff --git a/agent/fw_slim.c b/agent/fw_slim.c
@@ -152,6 +152,7 @@ NR_PHP_WRAPPER_END
 NR_PHP_WRAPPER(nr_slim_application_construct) {
   zval* this_var = nr_php_scope_get(NR_EXECUTE_ORIG_ARGS);
   char* version = NULL;
+  nr_php_package_t* p = NULL;
 
   NR_UNUSED_SPECIALFN;
   (void)wraprec;
@@ -160,11 +161,11 @@ NR_PHP_WRAPPER(nr_slim_application_construct) {
 
   if (NRINI(vulnerability_management_package_detection_enabled)) {
     // Add php package to transaction
-    nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
+    p = nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
   }
 
-  nr_txn_add_package_major_version_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
-                                                  version, nr_fw_support_add_package_supportability_metric);
+  nr_fw_support_add_package_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
+                                                  version, p);
 
   nr_free(version);
   nr_php_scope_release(&this_var);
diff --git a/agent/fw_support.c b/agent/fw_support.c
@@ -58,23 +58,36 @@ void nr_fw_support_add_logging_supportability_metric(nrtxn_t* txn,
 void nr_fw_support_add_package_supportability_metric(
     nrtxn_t* txn,
     const char* package_name,
-    const char* package_version) {
-  if (NULL == txn || NULL == package_name || NULL == package_version) {
+    const char* package_version,
+    nr_php_package_t* p) {
+  if (NULL == txn || NULL == package_name) {
     return;
   }
 
   char* metname = NULL;
   char major_version[MAJOR_VERSION_LENGTH] = {0};
+  const char* version = package_version;
+
+  // override provided package_version only if:
+  // - php_package is provided
+  // - its version is not NULL
+  if (NULL != p && NULL != p->package_version) {
+    version = p->package_version;
+  }
+
+  if (NULL == version) {
+    return;
+  }
 
   /* The below for loop checks if the major version of the package is more than
    * one digit and keeps looping until a '.' is encountered or one of the
    * conditions is met.
    */
-  for (int i = 0; package_version[i] && i < MAJOR_VERSION_LENGTH - 1; i++) {
-    if ('.' == package_version[i]) {
+  for (int i = 0; version[i] && i < MAJOR_VERSION_LENGTH - 1; i++) {
+    if ('.' == version[i]) {
       break;
     }
-    major_version[i] = package_version[i];
+    major_version[i] = version[i];
   }
 
   if (NR_FW_UNSET == NRINI(force_framework)) {
diff --git a/agent/fw_support.h b/agent/fw_support.h
@@ -8,6 +8,7 @@
 #define FW_SUPPORT_HDR
 
 #include "php_user_instrument.h"
+#include "nr_php_packages.h"
 
 extern void nr_php_framework_add_supportability_metric(
     const char* framework_name,
@@ -44,11 +45,13 @@ extern void nr_fw_support_add_logging_supportability_metric(
  * Params  : 1. Transaction object
  *           2. Package name
  *           3. Package version
+ *           4. PHP package reported for vulnerability management
  *
  */
 extern void nr_fw_support_add_package_supportability_metric(
     nrtxn_t* txn,
     const char* package_name,
-    const char* package_version);
+    const char* package_version,
+    nr_php_package_t* p);
 
 #endif /* FW_SUPPORT_HDR */
diff --git a/agent/fw_wordpress.c b/agent/fw_wordpress.c
@@ -806,15 +806,16 @@ void nr_wordpress_version() {
   zval retval;
   int result
       = zend_eval_string(func_string, &retval, "Get Wordpress Version");
+  nr_php_package_t* p = NULL;
   // Add php package to transaction
   if (SUCCESS == result) {
     if (nr_php_is_zval_valid_string(&retval)) {
       char* version = Z_STRVAL(retval);
       if (NRINI(vulnerability_management_package_detection_enabled)) {
-        nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
+        p = nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
       }
-      nr_txn_add_package_major_version_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
-                                                      version, nr_fw_support_add_package_supportability_metric);
+      nr_fw_support_add_package_supportability_metric(
+          NRPRG(txn), PHP_PACKAGE_NAME, version, p);
     }
     zval_dtor(&retval);
   }
diff --git a/agent/lib_aws_sdk_php.c b/agent/lib_aws_sdk_php.c
@@ -56,6 +56,7 @@ void nr_lib_aws_sdk_php_handle_version() {
   zval* zval_version = NULL;
   zend_class_entry* class_entry = NULL;
   char* version = NULL;
+  nr_php_package_t* p = NULL;
 
   class_entry = nr_php_find_class("aws\\sdk");
   if (NULL != class_entry) {
@@ -67,10 +68,10 @@ void nr_lib_aws_sdk_php_handle_version() {
   }
   if (NRINI(vulnerability_management_package_detection_enabled)) {
     /* Add php package to transaction */
-    nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
+    p = nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
   }
-  nr_txn_add_package_major_version_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
-                                                  version, nr_fw_support_add_package_supportability_metric);
+  nr_fw_support_add_package_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
+                                                  version, p);
   nr_php_zval_free(&zval_version);
 }
 
diff --git a/agent/lib_guzzle6.c b/agent/lib_guzzle6.c
@@ -352,10 +352,11 @@ NR_PHP_WRAPPER_START(nr_guzzle6_client_construct) {
   zval* this_var = nr_php_scope_get(NR_EXECUTE_ORIG_ARGS);
 
   char* version = nr_php_get_object_constant(this_var, "VERSION");
+  nr_php_package_t* p = NULL;
 
   if (NRINI(vulnerability_management_package_detection_enabled)) {
     // Add php package to transaction
-    nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
+    p = nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
   }
 
   /*
@@ -366,8 +367,8 @@ NR_PHP_WRAPPER_START(nr_guzzle6_client_construct) {
   if (NULL == version) {
     version = nr_php_get_object_constant(this_var, "MAJOR_VERSION");
   }
-  nr_txn_add_package_major_version_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
-                                                  version, nr_fw_support_add_package_supportability_metric);
+  nr_fw_support_add_package_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
+                                                  version, p);
   nr_free(version);
 
   (void)wraprec;
diff --git a/agent/lib_monolog.c b/agent/lib_monolog.c
@@ -378,8 +378,10 @@ NR_PHP_WRAPPER(nr_monolog_logger_addrecord) {
         = nr_monolog_get_timestamp(api, argc, NR_EXECUTE_ORIG_ARGS TSRMLS_CC);
     char version[MAJOR_VERSION_LENGTH];
     snprintf(version, sizeof(version), "%d", api);
-    nr_txn_add_package_major_version_supportability_metric(NRPRG(txn),
-                                                    PHP_PACKAGE_NAME, version, nr_fw_support_add_package_supportability_metric);
+    nr_fw_support_add_package_supportability_metric(
+        NRPRG(txn), PHP_PACKAGE_NAME, version,
+        nr_php_packages_get_package(NRPRG(txn)->php_packages,
+                                    PHP_PACKAGE_NAME));
   }
 
   /* Record the log event */
diff --git a/agent/lib_predis.c b/agent/lib_predis.c
@@ -644,6 +644,7 @@ NR_PHP_WRAPPER(nr_predis_client_construct) {
   zval* conn = NULL;
   zval* params = nr_php_arg_get(1, NR_EXECUTE_ORIG_ARGS TSRMLS_CC);
   zval* scope = nr_php_scope_get(NR_EXECUTE_ORIG_ARGS TSRMLS_CC);
+  nr_php_package_t* p = NULL;
 
   (void)wraprec;
 
@@ -652,9 +653,10 @@ NR_PHP_WRAPPER(nr_predis_client_construct) {
   char* version = nr_php_get_object_constant(scope, "VERSION");
   if (NRINI(vulnerability_management_package_detection_enabled)) {
     // Add php package to transaction
-    nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
+    p = nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);
   }
-  nr_txn_add_package_major_version_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME, version, nr_fw_support_add_package_supportability_metric);
+  nr_fw_support_add_package_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,
+                                                  version, p);
   nr_free(version);
 
   /*
diff --git a/agent/tests/test_fw_support.c b/agent/tests/test_fw_support.c
diff --git a/axiom/nr_txn.c b/axiom/nr_txn.c
diff --git a/axiom/nr_txn.h b/axiom/nr_txn.h

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,7 @@ void nr_lib_aws_sdk_php_handle_version() {`
`56`	`56`	`zval* zval_version = NULL;`
`57`	`57`	`zend_class_entry* class_entry = NULL;`
`58`	`58`	`char* version = NULL;`
	`59`	`+ nr_php_package_t* p = NULL;`
`59`	`60`
`60`	`61`	`class_entry = nr_php_find_class("aws\\sdk");`
`61`	`62`	`if (NULL != class_entry) {`
`@@ -67,10 +68,10 @@ void nr_lib_aws_sdk_php_handle_version() {`
`67`	`68`	`}`
`68`	`69`	`if (NRINI(vulnerability_management_package_detection_enabled)) {`
`69`	`70`	`/* Add php package to transaction */`
`70`		`- nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);`
	`71`	`+ p = nr_txn_add_php_package(NRPRG(txn), PHP_PACKAGE_NAME, version);`
`71`	`72`	`}`
`72`		`- nr_txn_add_package_major_version_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,`
`73`		`- version, nr_fw_support_add_package_supportability_metric);`
	`73`	`+ nr_fw_support_add_package_supportability_metric(NRPRG(txn), PHP_PACKAGE_NAME,`
	`74`	`+ version, p);`
`74`	`75`	`nr_php_zval_free(&zval_version);`
`75`	`76`	`}`
`76`	`77`