DDEV DDEV-Local tutorials, 27 Aug 2020

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Debugging Code in No Time with DDEV-Local, PhpStorm, and Xdebug

Description

No more print-line debugging! The combination of PhpStorm and DDEV-Local's plug-and-play approach to debugging enables you to easily create a working debug environment in just a few minutes. In this screencast, we’ll walk you through using macOS — but it works exactly the same on Windows, Linux, and WSL2.

Short on time? Skip to the good stuff:
Overview (0:51)
Installing DDEV-Local (0:59)
Installing PhpStorm (1:40)
Creating a PhpStorm project and setting a breakpoint (2:24)
Configure DDEV project (3:18)
ddev xdebug on (4:12)
Creating a PhpStorm "server" or "mapping" automatically (5:14)
First breakpoint! (5:42)
Command-line debugging (8:00)
Resources (9:58)

Resources:
Get started with the DDEV-Local Docs: https://bit.ly/3hqjz1Q
Read up on step debugging with DDEV and Xdebug: https://bit.ly/3nWq3bc
Start using PhpStorm with WSL2: https://bit.ly/3rzph62
Looking for a little help? Get in touch: https://bit.ly/34PVLiC
If you’re ready to deploy, check out our web hosting solution: DDEV-Live: https://bit.ly/3rCdAf9

A

Hi, my name is randy fay, I'm the maintainer of ddev's ddev local project, which is a local development environment that helps teams to view their websites right on their local machine without doing a whole bunch of config on their machine.

A

I just finished doing a d dev local from scratch on mac os, so I had a pretty clean machine, so I wanted to demonstrate how easy it is to get dweb, local and x, debug and phpstorm, working together on a very, very clean machine. This is with no prior configuration, no fiddling, none of the things that people worry about with configuring debugging in php. So let's go ahead and try it we're going to just do these steps. Dev has x, debug all built in, and the configuration's all built in. You don't have to do anything.

A

So, let's just install ddo, so we will do a brew. Install dev.

A

Oops we have to do a brew, tap drug dev first.

A

Now we can do a brew, install drug brew installed d-dev.

A

Okay, there we have it, we have dwiv installed version and now, let's get phpstorm installed, I'm going to use brew to install it, but this is the same as downloading from the jetbrains website.

A

Okay, phpstorm is installed, so let's go ahead and run it.

A

I lost my window here. We are, I'm going to say, send it's always nice to help developers out I'm just going to evaluate for free for right now.

A

Now I'm going to open a project, I have a drupal 9 project. It doesn't matter we're not doing anything very exciting, but I have a drupal 9 project just sitting here. Waiting for us.

A

Don't show tips for now. Thank you and the index.php is right here in the web directory yeah standard drupal 9 build.

A

So I'm going to put a break point right here at the beginning.

A

I am going to let it finish indexing before I continue so I'll be back when it gets done indexing since we're doing it back well, we'll switch over and we'll just do use ddf to configure this thing. Okay, while we're waiting for phpstorm to get everything indexed, we are just going to use ddev to configure this project we're going to do a ddap config in this d9 directory. This is a drupal 9 directory and it sees the project name. It finds it auto detected the docker location as web.

A

It auto detected the project type as drupal and that's it now. I can do a d dev start now, the very first time you had done a d dev start it would have to pull some images. That's a one time thing per date of release.

A

We have all the images in docker already here, so it's not having to do that. So it's just bringing it right up.

A

Okay, there it is, and we are going to.

A

D of this is important.

A

We're going to do d dev x, debug on the x debug has a performance penalty, uh especially in docker-based environments, but really everywhere and so dev usually has it turned off we're going to turn it on with the dev x debug on and now we're going to go back to phpstorm and it seems like it's in pretty good shape.

A

We have a breakpoint set. Now I'm going to use the little listen button up here and I'm going to say, listen to it and we should be ready that we can just go to dnad9.dev.site.

A

The dwf describe shows you what the urls are here, so I could just click through to this and there it is, and it pops up right away in phpstorm and it's asking us what index.php were we trying to use and then the one that we're trying to use is the one in our project's web folder.

A

So that's the one it's trying to map it and it's going to make that into what they call a server. It's actually actually a file mapping, I'm going to say, okay and there we are. We have stopped at the first line and we have our. We have our variables here and I can hit f8 and step through, and I can step in to request and see everything that's going on here.

A

You can't live without debugging. You can't live without being able to understand the context of what your code is doing. Okay, so I am going to stop this debug section session. We got it all working now that we've done that. If I go, if I go back over here and hit the hit the thing again now, it doesn't ask for the mapping anymore, because the mapping saved, let me show you where that mapping is.

A

If you look for servers.

A

It shows it up here in the php debug section, um and so we just it just created for us a server called d9.dev.site, I'm not exactly sure why they call it a server it's as far as I can tell it's only a mapping of paths on the host two paths in the container. So this is the path in the host, and this is a path in the container and it would have actually been better if, if it had done it for us here and put yeah hang on just second here.

A

I want to I want to oh here we are, I want to put far www.w.html there and that would be a little more complete, but it doesn't matter it. It worked. It did what we wanted. So now we have that created.

A

Now, let's take a look at what we did. Dev has x, debug built in we just installed. Ddev we installed phpstorm, we opened the project, we did a dev config and a d dev start. Then we enabled phpstorms, listen button turned we. We said dwx debug on. We set a breakpoint, we visited the site and it popped up a little mapping, dialog box for us and as a one-time thing, we did it okay, so there it is now I'm going to do the same thing with command line debugging.

A

I know that we all have lots of command line work to do it's basically, the same once we've got that mapping set up once we've got that server set up, so we have that server set up. So we are going to go. I'm going to stop this here and I'm going to go in here. I'm going to do a ddaf ssh how you get into the container and here's index.php, I'm going to run that index.php manually. We still have our breakpoint set there there.

A

It is phpstorm pops up and we are now stepping through something that is a command line php. So here we go and there we are same same exact thing: we've got both web-based and command-line based x, debug, going without having done any configuration at all.

A

Now, if you already have storm going and you're trying to solve these problems solve problems that you might have with potential configuration you can go in to the preferences and the you can remove server that you have if it doesn't suit you, um probably the most likely thing that could have happened to you would be to not have these default settings under the debug section like if you change the port number in phpstorm.

A

uh Those kind of things, then that that can uh that can do your harm, but here's these are the default settings here. Xdebug is all that we care about and we're just using the standard stuff. So.

A

Let's go ahead and take a look here: the resources for you, uh ddev local docs, are at dwev.readthedocs.io debug. You can just search for x debug in the docs there. The dwf local repo is at github.com, and please don't forget about ddev.com. The sponsor of ddevlocal do try out their new dwev live hosting product which has a 10-day free trial. It we would love to have your feedback I'd love to have you kick the tires and give us feedback about it.

A

Thank you very much.