Skip to content

style(agent): drupal code formatting #1029

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Feb 25, 2025
Merged

style(agent): drupal code formatting #1029

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
82ad286
chore: format fw_drupal8 code
bduranleau-nr Feb 24, 2025
5959589
chore: format fw_drupal code
bduranleau-nr Feb 24, 2025
1654b33
chore: format fw_drupal_common code
bduranleau-nr Feb 24, 2025
efe0a00
fix: add format protections
bduranleau-nr Feb 25, 2025
fca6ace
adjust docstring indentation
bduranleau-nr Feb 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions agent/fw_drupal.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,8 +484,7 @@ static void nr_drupal_wrap_hook_within_module_invoke_all(
*/
#if ZEND_MODULE_API_NO >= ZEND_8_0_X_API_NO \
&& !defined OVERWRITE_ZEND_EXECUTE_DATA
zval* curr_hook
= (zval*)nr_stack_get_top(&NRPRG(drupal_invoke_all_hooks));
zval* curr_hook = (zval*)nr_stack_get_top(&NRPRG(drupal_invoke_all_hooks));
if (!nr_php_is_zval_non_empty_string(curr_hook)) {
nrl_verbosedebug(NRL_FRAMEWORK,
"%s: cannot extract hook name from global stack",
Expand Down
46 changes: 21 additions & 25 deletions agent/fw_drupal8.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,7 @@ NR_PHP_WRAPPER(nr_drupal_exception) {

if (NR_SUCCESS
!= nr_php_error_record_exception(NRPRG(txn), exception, priority, true,
NULL,
&NRPRG(exception_filters))) {
NULL, &NRPRG(exception_filters))) {
nrl_verbosedebug(NRL_TXN, "Drupal: unable to record exception");
}

Expand Down Expand Up @@ -134,12 +133,12 @@ static void nr_drupal8_add_method_callback(const zend_class_entry* ce,
#if ZEND_MODULE_API_NO >= ZEND_8_0_X_API_NO \
&& !defined OVERWRITE_ZEND_EXECUTE_DATA
static void nr_drupal8_add_method_callback_before_after_clean(
const zend_class_entry* ce,
const char* method,
size_t method_len,
nrspecialfn_t before_callback,
nrspecialfn_t after_callback,
nrspecialfn_t clean_callback) {
const zend_class_entry* ce,
const char* method,
size_t method_len,
nrspecialfn_t before_callback,
nrspecialfn_t after_callback,
nrspecialfn_t clean_callback) {
zend_function* function = NULL;

if (NULL == ce) {
Expand All @@ -164,13 +163,13 @@ static void nr_drupal8_add_method_callback_before_after_clean(
nr_php_class_entry_name(ce), NRSAFELEN(method_len), method);

nr_php_wrap_user_function_before_after_clean(
class_method, nr_strlen(class_method),
before_callback, after_callback, clean_callback);
class_method, nr_strlen(class_method), before_callback, after_callback,
clean_callback);

nr_free(class_method);
}
}
#endif // OAPI
#endif // OAPI

/*
* Purpose : Check if the given function or method is in the current call
Expand Down Expand Up @@ -501,8 +500,7 @@ NR_PHP_WRAPPER(nr_drupal94_invoke_all_with_callback) {

#if ZEND_MODULE_API_NO >= ZEND_8_0_X_API_NO \
&& !defined OVERWRITE_ZEND_EXECUTE_DATA
zval* curr_hook
= (zval*)nr_stack_get_top(&NRPRG(drupal_invoke_all_hooks));
zval* curr_hook = (zval*)nr_stack_get_top(&NRPRG(drupal_invoke_all_hooks));
if (UNEXPECTED(!nr_php_is_zval_non_empty_string(curr_hook))) {
nrl_verbosedebug(NRL_FRAMEWORK,
"%s: cannot extract hook name from global stack",
Expand All @@ -515,7 +513,7 @@ NR_PHP_WRAPPER(nr_drupal94_invoke_all_with_callback) {
nr_drupal_hook_instrument(Z_STRVAL_P(module), Z_STRLEN_P(module),
NRPRG(drupal_invoke_all_hook),
NRPRG(drupal_invoke_all_hook_len) TSRMLS_CC);
#endif // OAPI
#endif // OAPI

leave:
NR_PHP_WRAPPER_CALL;
Expand All @@ -536,7 +534,7 @@ NR_PHP_WRAPPER(nr_drupal94_invoke_all_with) {
|| defined OVERWRITE_ZEND_EXECUTE_DATA
char* prev_hook = NULL;
int prev_hook_len;
#endif // not OAPI
#endif // not OAPI

(void)wraprec;

Expand All @@ -547,7 +545,7 @@ NR_PHP_WRAPPER(nr_drupal94_invoke_all_with) {
#if ZEND_MODULE_API_NO >= ZEND_8_0_X_API_NO \
&& !defined OVERWRITE_ZEND_EXECUTE_DATA
nr_php_arg_release(&hook);
#endif // OAPI
#endif // OAPI
goto leave;
}

Expand All @@ -561,7 +559,7 @@ NR_PHP_WRAPPER(nr_drupal94_invoke_all_with) {
= nr_strndup(Z_STRVAL_P(hook), Z_STRLEN_P(hook));
NRPRG(drupal_invoke_all_hook_len) = Z_STRLEN_P(hook);
NRPRG(check_cufa) = true;
#endif // OAPI
#endif // OAPI
callback = nr_php_arg_get(2, NR_EXECUTE_ORIG_ARGS TSRMLS_CC);

/* This instrumentation will fail if callback has already been wrapped
Expand All @@ -581,14 +579,14 @@ NR_PHP_WRAPPER(nr_drupal94_invoke_all_with) {
if (NULL == NRPRG(drupal_invoke_all_hook)) {
NRPRG(check_cufa) = false;
}
#endif // not OAPI
#endif // not OAPI

leave: ;
leave:;
#if ZEND_MODULE_API_NO < ZEND_8_0_X_API_NO \
|| defined OVERWRITE_ZEND_EXECUTE_DATA
/* for OAPI, the _after callback handles this free */
nr_php_arg_release(&hook);
#endif // not OAPI
#endif // not OAPI
}
NR_PHP_WRAPPER_END

Expand All @@ -605,7 +603,7 @@ NR_PHP_WRAPPER(nr_drupal94_invoke_all_with_clean) {
nr_drupal_invoke_all_hook_stacks_pop();
}
NR_PHP_WRAPPER_END
#endif // OAPI
#endif // OAPI

/*
* Purpose : Wrap the invoke() method of the module handler instance in use.
Expand Down Expand Up @@ -642,10 +640,8 @@ NR_PHP_WRAPPER(nr_drupal8_module_handler) {
#if ZEND_MODULE_API_NO >= ZEND_8_0_X_API_NO \
&& !defined OVERWRITE_ZEND_EXECUTE_DATA
nr_drupal8_add_method_callback_before_after_clean(
ce, NR_PSTR("invokeallwith"),
nr_drupal94_invoke_all_with,
nr_drupal94_invoke_all_with_after,
nr_drupal94_invoke_all_with_clean);
ce, NR_PSTR("invokeallwith"), nr_drupal94_invoke_all_with,
nr_drupal94_invoke_all_with_after, nr_drupal94_invoke_all_with_clean);
#else
nr_drupal8_add_method_callback(ce, NR_PSTR("invokeallwith"),
nr_drupal94_invoke_all_with TSRMLS_CC);
Expand Down
5 changes: 3 additions & 2 deletions agent/fw_drupal_common.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,9 @@ nr_status_t module_invoke_all_parse_module_and_hook_from_strings(
nrl_verbosedebug(NRL_FRAMEWORK,
"%s: module len is %d; ; "
"hook='%.*s'; module_hook='%.*s'",
__func__, (int)module_len, NRSAFELEN(hook_len), NRSAFESTR(hook),
NRSAFELEN(module_hook_len), NRSAFESTR(module_hook));
__func__, (int)module_len, NRSAFELEN(hook_len),
NRSAFESTR(hook), NRSAFELEN(module_hook_len),
NRSAFESTR(module_hook));

return NR_FAILURE;
}
Expand Down
16 changes: 8 additions & 8 deletions agent/fw_drupal_common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,23 +147,23 @@ nr_status_t module_invoke_all_parse_module_and_hook_from_strings(
*/
void nr_drupal_headers_add(zval* arg, bool is_drupal_7 TSRMLS_DC);


#if ZEND_MODULE_API_NO >= ZEND_8_0_X_API_NO \
&& !defined OVERWRITE_ZEND_EXECUTE_DATA
/*
* Purpose: Before an invoke_all style call, adds the hook to that hook states stacks
* Purpose: Before an invoke_all style call, adds the hook to that hook states
* stacks
*
* Params : 1. A zval holding a copy of the hook invoked, to be managed by the hook
* states stacks and freed by nr_drupal_invoke_all_hook_stacks_pop() after the
* invoke_all call completes
* Params : 1. A zval holding a copy of the hook invoked, to be managed by the
* hook states stacks and freed by nr_drupal_invoke_all_hook_stacks_pop() after
* the invoke_all call completes
Copy link
Member

@lavarou lavarou Feb 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seem right. The same file shows Purpose and Params docs strings, that span multiple lines, indented.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've manually fixed this here: fca6ace
For future reference, the reason for this is not due to a mis-configuration of clang-format. This is due to the line length limit (80 chars) and clang-format not being clever enough to match the indentation style in a docstring like this. These kinds of cases will require manual intervention.

*/
void nr_drupal_invoke_all_hook_stacks_push(zval* hook_copy);

/*
* Purpose: After an invoke_all style call, pops that states stack and conditionally
* pops the hook stack based on the previously popped state
* Purpose: After an invoke_all style call, pops that states stack and
* conditionally pops the hook stack based on the previously popped state
*/
void nr_drupal_invoke_all_hook_stacks_pop();
#endif // OAPI
#endif // OAPI

#endif /* FW_DRUPAL_COMMON_HDR */
Loading