Introducing Discourse developer toolbar

Dev
1

When running the latest version of Discourse core in a development environment, you’ll notice a new toolbar on the left-hand-side of the screen:

Developer Tools
Developer Tools804×536 21.7 KB

This provides one-click access to commonly-needed developer tools. So far, we have:

:electric_plug: Plugin Outlet Debug

This shows all plugin outlets, with tooltips showing realtime values of all of the available @outletArgs.

This was inspired by the popular plugin outlet locations theme component, and the plugin before it. But unlike those, the tight integration with core means it can always be 100% up-to-date with the latest outlets & arguments.

:ambulance: Safe ​mode

Toggles safe mode on and off

:scroll: Verbose localization

Toggles the verbose localization feature

In development, this is enabled by default, and can be disabled using the ‘X’ button.

In production, it can be enabled by running enableDevTools() in the browser console. You can even try it here on Meta! If enableDevTools() is not available, it’s probably because you’re on an error page which doesn’t load the full Ember app.

We hope to add more tools over the coming weeks/months, so watch this space! If you have any feedback, or ideas for tools, let us know below!

44 Likes
2

Clicking the :electric_plug: icon to show outlets makes Chrome crash, making the page/tab unresponsive. I disabled my Chrome extensions, but it still crashes.

More specifically, it crashes when clicking the icon while on a topic (not only on meta).

On Firefox/Edge, it works but there’s an error in the console:

Multiple connectors were registered for the discovery-list-area outlet. Using the first. 
Array [ undefined, "discovery-list-area/kanban-board (discourse/theme-351/discourse/connectors/discovery-list-area/kanban-board)" ]
3 Likes
3

I can reproduce it on Meta as well.

On Firefox, you can see that there is also a rendering infinite loop:

The image displays a JavaScript console error message "Uncaught (in promise) Error: infinite rendering invalidation detected" next to a list of numbers and strings: '7', '29', '_trigger', 'end', 'endor;' which appear to be part of a code line. (Captioned by AI)
The image displays a JavaScript console error message "Uncaught (in promise) Error: infinite rendering invalidation detected" next to a list of numbers and strings: '7', '29', '_trigger', 'end', 'endor;' which appear to be part of a code line. (Captioned by AI)518×206 2.51 KB

It works fine on a local dev installation, even with Kanban enabled. I see the same error, but there is no rendering loop.

By the way, thanks for bringing this tool, it’s really convenient, love it!

2 Likes
4

Huh! It definitely worked a few days ago, but now I see the same error. I’ll investigate - thanks for the reports!

6 Likes
6

Just merged this commit which will fix the infinite-rerendering on the topic page

8 Likes
8

Since I don’t see any way to do this on mobile, I’m working on a simple TC to add a button to the header (inspired by the Plugin Outlets TC).

9

When viewing a development environment on mobile, the toolbar will appear on the left of the screen so you can use it as normal.

In production environments, you’ll need to call enableDevTools() from the console (or from theme/theme-component javascript) to turn on the toolbar. Note that this has a performance cost, so you shouldn’t do it for all users on a real production site.

2 Likes
10

Yep. Users can click the button to activate dev tools for them. Not for all users.

1 Like
11

Here it is:

1 Like
12

Can we have a toggle for mobile_view? Sometimes, I want to check quickly this view.
I can make a PR if so!

3 Likes
13

Why not the toggle in the sidebar though?

1 Like
14

You don’t have the mobile toggle in desktop mode. I believe it appears only on mobile or tablet.
Also, this is about the convenience of having all the buttons in the same place.

2 Likes
15

Sure, mobile mode sounds like a good one to add :+1:

3 Likes
16

There we go:

2 Likes
17

I just wanted to shout out, and thank you for this handy dev tool.

Identifying the available plugin outlets is a breeze now, or pinpointing the localization strings…

Thanks! :smiley:

5 Likes
18

But it doesn’t work on the 404 page?

Visit https://meta.discourse.org/ewfsezfef, hit F12, enable dev tools, and

image
image270×115 5.77 KB

VM190:1 Uncaught ReferenceError: enableDevTools is not defined
    at <anonymous>:1:1

I was hoping to add some text to that page.

3 Likes
19

Right now the 404 pages don’t load any of the ember app JS. There is a hidden site setting bootstrap_error_pages which you can enable to make them full ember app pages.

Perhaps we’ll make that the default in future, but it’s not at the top of our priority list right now.

2 Likes
20

Makes sense. Maybe add that to the OP? It looks like I can do it.

1 Like
21

Sure! added:

2 Likes