2.9 KiB
| title | description | keywords | redirect_from | |
|---|---|---|---|---|
| Test and debug | Test and debug your extension. | Docker, Extensions, sdk, preview, update, Chrome DevTools |
|
In order to improve the developer experience, Docker Desktop provides a set of tools to help you test and debug your extension.
Open Chrome DevTools
In order to open the Chrome DevTools for your extension when you click on the extension tab, run:
$ docker extension dev debug <name-of-your-extensions>
Each subsequent click on the extension tab will also open Chrome Dev Tools. To stop this behaviour, run:
$ docker extension dev reset <name-of-your-extensions>
After an extension is deployed, it is also possible to open Chrome DevTools from the UI extension part using a variation of the Konami Code{:target="blank" rel="noopener" class=""}. Click on the extension tab, and then hit the key sequence up, up, down, down, left, right, left, right, p, d, t.
Hot reloading whilst developing the UI
During UI development, it’s helpful to use hot reloading to test your changes without rebuilding your entire extension. To do this, you can configure Docker Desktop to load your UI from a development server, such as the one Create React App starts when invoked with yarn start.
Assuming your app runs on the default port, start your UI app and then run:
$ cd ui
$ npm run dev
This starts a development server that listens on port 5173.
You can now tell Docker Desktop to use this as the frontend source. In another terminal run:
$ docker extension dev ui-source <name-of-your-extensions> http://localhost:5173
Close and reopen the Docker Desktop dashboard and go to your extension. All the changes to the frontend code are immediately visible.
Once finished, you can reset the extension configuration to the original settings. This will also reset opening Chrome dev tools if you used docker extension dev debug <name-of-your-extensions>:
$ docker extension dev reset <name-of-your-extensions>
Show the extension containers
If your extension is composed of one or more services running as containers in the Docker Desktop VM, you can access them easily from the dashboard in Docker Desktop.
- In Docker Desktop, navigate to Settings or Preferences if you’re a Mac user.
- Under the Extensions tab, select the Show Docker Desktop Extensions system containers option. You can now view your extension containers and their logs.
Clean up
To remove the extension, run:
$ docker extension rm <name-of-your-extension>
What's next
- Build an advanced frontend extension.
- Learn more about extensions architecture.
- Learn more about designing the UI.