How to make xdebug work with espocrm

[goodwill]

Hi there ,
I am trying to develop an extension,
I'm trying to make xdebug work with Espocrm but I have had no luck so far,

my debug config is

xdebug.mode = debug
xdebug.start_with_request = yes

and my vscode config is

{
    "version": "0.2.0",
       "configurations": [
         {
            "name": "Listen for Xdebug",
            "type": "php",
            "request": "launch",
            "port": 9003,
         }
      ]
}

I can debug any other project just like this, but when I try to use it with Espocrm I can see call stack but my ide doesn't stop at breakpoints
There is no error in my xdebug and apache log file

I have enabled isDeveloperMode and useCache is false

Could someone share with me a working config, what am I doing wrong

Thanks in advance

[goodwill]

Seems like the problem is related to path mapping, seriously could use some advice
I have struggled with this problem for the past 2 days

Is there a Developer who is using Xdebug, could someone share his/her phpStorm / vsCode (workspace/launcher) config with me ( Path Mapping Part !)

[yuri]

If you use ext-template, source files are not executed/interpreted by php. There's a copy step that copies the module files to the site folder from where they are interpreted when you running Espo. Maybe that's the reason.

[goodwill]

If you use ext-template, source files are not executed/interpreted by php. There's a copy step that copies the module files to the site folder from where they are interpreted when you running Espo. Maybe that's the reason.

That's not the case the problem is when I try to intercept my module requests that go to /public/api/index.php, couldn't get intercepted
I can't figure it out I did try different pathMappings but no luck

I'm trying to extend the Tasks API Controller

namespace Espo\Custom\Controllers;

use Espo\Core\Api\Request;
use Espo\Core\Api\Response;

// ... extend Tasks

When I try to intercept for example inside

application/Espo/Core/Api/Request.php

My breakpoint doesn't stop, I thought maybe because the API path has a rewrite rule, but I couldn't figure it out

Do you set custom path mapping for your project or any custom config?

I'm kinda old school I prefer stepping into code with a debugger rather than reading documents,
It's way more effective for me, but I had no luck

I know Intercepting something like hasQueryParam going to fire like crazy since it's getting called many times over
But I like to watch how everything works internally at least once so I could be more effective and prevent reading RAW code / Documents / Trial and Error

Edited
Oh I just saw you are the man behind the wheel
Dude, you are one awesome fella

Can I suggest some documentation on an advanced development environment / CI | CD
I could help write up some technical documentation If I could figure out some startup hurdles like this debugging problem
I'm quite experienced in DevOps ( especially Docker)

I could create a template ( composer ) for development with remote debugging and integrated ext-template cli, demo data, etc

[yuri]

Hi,

I must admit I don't use Xdebug at the moment Configuration process is so debilitating (and I work from different PCs) and everything works so much slower. Last time I tried to configure PHPStorm + Xdebug I failed, could not afford myself spend more time on it. I should try again maybe.

I find that I need to debug something in PHP not that often. Might be because I know Espo codebase enough and static analysis catches a lot of issues before I need to debug.


> Can I suggest some documentation

Maybe would be helpful. Not sure what do you mean though. Docker file + docker compose for developer environment? We have the repository https://github.com/tmachyshyn/espocr...nt/tree/master with basic environment setups.

[yuri]

Mod rewrite should not affect on Xdebug as far as I know.

[yuri]

BTW nice article https://lemire.me/blog/2016/06/21/i-...se-a-debugger/ indulging my confirmation bias that I don't use debuggers

[yuri]

The API processing is not that complicated. You can check the route file application/Espo/Resources/routes.json. Basic CRUD requests are going to Espo\Core\Controllers\RecordBase. Other request entry points can be obtained from the route file.

After the Record controller, the CRUD requests are following to Espo\Core\Record\Service. Which does needed operations and returns response data.

[goodwill]

Thank you so much for the tips and help
When you have a lot of throughput in a platform with loads of async code it is pretty useful, especially for understanding the code
Since you are the Code Codebase literally, you don't need it <3

I will try to figure it out and document it, maybe you gave it a shot

[espcrm]

yuri recommend some IDE which will help with this problem. Personally I don't code so I never noted it down which IDE.

[goodwill]

espcrm I think he is using PHPStorm, you can see in Github repo .idea folder, he is putting more effort into setting up the workspace in PHPStorm than VSCode ( Since VSCode folder doesn't have many configurations ), I will try to put some time into setting up some configuration options for VSCode too