Fixed issue #1898: API for querying the active mode(s) #733

johnstevenson · Mar 21, 2021

Although it is possible to obtain the mode value in userland, it is
quite cumbersome and possibly brittle to do so. This is fixed with the
addition of an xdebug_mode() function:

xdebug_mode(?string $mode = null) : mixed

Returns the enabled xdebug modes as a comma-separated string, or if the
$mode parameter is supplied, whether the named mode(s) are set.

For example, using xdebug.mode=debug,develop,coverage.

var_dump(xdebug_mode());                  // string(22) "develop,coverage,debug"
var_dump(xdebug_mode('off'));             // bool(false)
var_dump(xdebug_mode('debug,coverage'));  // bool(true)
var_dump(xdebug_mode('trace,debug'));     // bool(false)

johnstevenson · Mar 21, 2021

The failing test on PHP-8.1 (nightly) on Ubuntu is not related to this PR and occurs on xdebug:master as well:

TEST 7/738 [tests/base/bug00665.phpt]
========DIFF========
004- PASS4
006- PASS6
010- PASS10
012- PASS12
========DONE========
FAIL Test for bug #665: xdebug does not respect display_errors=stderr [tests/base/bug00665.phpt]

This test passes on Windows nightly builds.

EDIT: This failed on PHP php/php-src@6690547 but now seems to be okay.

Although it is possible to obtain the mode value in userland, it is quite cumbersome and possibly brittle to do so. This is fixed with the addition of an `xdebug_mode()` function: xdebug_mode(?string $mode = null) : mixed Returns the enabled xdebug modes as a comma-separated string, or if the `$mode` parameter is supplied, whether the named mode(s) are set. For example, using `xdebug.mode=debug,develop,coverage`. ``` var_dump(xdebug_mode()); // string(22) "develop,coverage,debug" var_dump(xdebug_mode('off')); // bool(false) var_dump(xdebug_mode('debug,coverage')); // bool(true) var_dump(xdebug_mode('trace,debug')); // bool(false) ```

johnstevenson · Mar 22, 2021

Derek wrote:

This is a duplicate of 0001898, which I'll implement for 3.1. I'm still pondering how to make this more useful than just returning a list of enabled modes though.

I've updated the commit message to match the already-reported issue. Please consider this PR as an example of such a function and do with it as you wish.

mvorisek · Mar 29, 2021

src/lib/log.c

+		xdebug_str_add_literal(&mode_out, "off");
+	} else {
+		if (XDEBUG_MODE_IS(XDEBUG_MODE_DEVELOP)) {
+			xdebug_str_add_literal(&mode_out, "develop,");


an array would be better

I'm sure Derek is going to do his own thing here, but why do you think that an array would be better?

well, to me, an array of strings seems easier to understand than a single string, where we need to remember that the string actually contains multiple modes in a comma-separated way (for which a check would probably be done by exploding the string anyway)

@stof Yeah, I get that. But you don't need to explode the string to do an in_array() check, because you already have xdebug_mode('modes,you,want,to,check') functionality which returns true/false.

I have assumed that usage would be either to check a value (as above), or to set a value(s) in a new process - which you can do simply with $mode = xdebug_mode().',modes,you,need'; etc, rather than having to implode an array.

I also thought that if you returned an array of values, you should really only accept an arrary of values, for consistency, which seemed cumbersome if you only wanted to check a single value.

xdebug_mode().',modes,you,need' is one example why you want array ;-)

Clean code is array_unique([...xdebug_mode(), 'modes', 'you', 'need']) :)

@mvorisek Why? It doesn't matter (each value is just OR-ed to the current value) and is consistent with how the ini and env values are parsed/used.

stof · Apr 13, 2021

should this be a single function having 2 totally different behavior depending on whether it is called with 1 or 2 parameters, or 2 separate functions ?

stof · Apr 13, 2021

we could have xdebug_mode_is_active(string $mode): bool for the case of checking whether one mode is active.

derickr · Apr 13, 2021

What I likely want to do is to extend xdebug_info() with an (optional) argument that returns information based on that argument.

Right now, xdebug_info() returns nothing, and instead displays a whole lot of information. Much of that information could be useful for applications that need to do something with it, such as checking modes. I don't really want to add a separate function for each of these "feature" requests, and hence likely want to go with:

xdebug_info('modes');, which will then return an array of which modes are enabled, and whether they have been activated. Likely returning an array as:

[
    'develop' => 'active',   // develop is always either 'active' or 'disabled', as there is no session associated with it
    'debug' => 'enabled',   // debug was turned on, but no debugging session active
    'coverage' => 'disabled', // coverage wasn't enabled at all
]

Alternatively I could make multiple arguments to xdebug_info() to make this not a tri-state, such as allowing for:
xdebug_info('enabled_modes') and xdebug_info('active_modes');.

And then perhaps later I can extend this with xdebug_info('profile') to give information about the current profiling session, perhaps to include the file name that the profile is written too (now you can use xdebug_get_profile_name() for that. etc etc.

derickr · Apr 21, 2021

I have for now settled on:

$ XDEBUG_MODE=debug,coverage php -dxdebug.mode=trace -r 'var_dump(xdebug_info("mode"));'
array(2) {
  [0]=>
  string(8) "coverage"
  [1]=>
  string(5) "debug"
}

Let me know if that works. With that, I'll close this PR and y'all can follow #737

johnstevenson · Apr 21, 2021

Thanks @derickr Seems like a nice uncomplicated solution.

johnstevenson force-pushed the mode branch from ac870c6 to 917c98f Compare March 22, 2021 11:06

johnstevenson changed the title ~~Fixed issue #1959: Add a function to obtain xdebug mode~~ Fixed issue #1898: API for querying the active mode(s) Mar 22, 2021

johnstevenson mentioned this pull request Mar 25, 2021

Xdebug 3 support composer/xdebug-handler#114

Closed

mvorisek reviewed Mar 29, 2021

View reviewed changes

ralphschindler mentioned this pull request Apr 13, 2021

[ErrorHandler] Avoid calling xdebug_get_function_stack() in xdebug >= 3.0 when not in develop mode symfony/symfony#40787

Closed

derickr closed this Apr 21, 2021

johnstevenson deleted the mode branch April 21, 2021 17:26

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Fixed issue #1898: API for querying the active mode(s) #733

Fixed issue #1898: API for querying the active mode(s) #733

Uh oh!

johnstevenson commented Mar 21, 2021

Uh oh!

johnstevenson commented Mar 21, 2021 •

edited

Loading

Uh oh!

johnstevenson commented Mar 22, 2021

Uh oh!

mvorisek Mar 29, 2021

Uh oh!

johnstevenson Apr 7, 2021

Uh oh!

stof Apr 13, 2021

Uh oh!

johnstevenson Apr 13, 2021

Uh oh!

mvorisek Apr 13, 2021 •

edited

Loading

Uh oh!

johnstevenson Apr 13, 2021

Uh oh!

stof commented Apr 13, 2021

Uh oh!

stof commented Apr 13, 2021

Uh oh!

derickr commented Apr 13, 2021

Uh oh!

derickr commented Apr 21, 2021

Uh oh!

johnstevenson commented Apr 21, 2021

Uh oh!

Uh oh!

Search code, repositories, users, issues, pull requests...

Uh oh!

Fixed issue #1898: API for querying the active mode(s) #733

Fixed issue #1898: API for querying the active mode(s) #733

Uh oh!

Conversation

johnstevenson commented Mar 21, 2021

xdebug_mode(?string $mode = null) : mixed

Uh oh!

johnstevenson commented Mar 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

johnstevenson commented Mar 22, 2021

Uh oh!

mvorisek Mar 29, 2021

Choose a reason for hiding this comment

Uh oh!

johnstevenson Apr 7, 2021

Choose a reason for hiding this comment

Uh oh!

stof Apr 13, 2021

Choose a reason for hiding this comment

Uh oh!

johnstevenson Apr 13, 2021

Choose a reason for hiding this comment

Uh oh!

mvorisek Apr 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

johnstevenson Apr 13, 2021

Choose a reason for hiding this comment

Uh oh!

stof commented Apr 13, 2021

Uh oh!

stof commented Apr 13, 2021

Uh oh!

derickr commented Apr 13, 2021

Uh oh!

derickr commented Apr 21, 2021

Uh oh!

johnstevenson commented Apr 21, 2021

Uh oh!

Uh oh!

johnstevenson commented Mar 21, 2021 •

edited

Loading

mvorisek Apr 13, 2021 •

edited

Loading