crm-ui-debug - If in debug mode, then load pretty-printer for JSON data

[totten]

Overview

The Angular directive crm-ui-debug is used to conditionally dump debug details on an AngularJS-based page (i.e. if the user requests ?angularDebug=1). This patch improves the formatting.

Before

The debug data is serialized to JSON and dumped as a large text blob (<pre>{{myData|json}}</pre>).

For objects with deep graphs, it's hard to see the structure.

After

The debug data is printed as a pretty tree with highlighting and expandable/collapsible sections.

Technical Details

The pretty printer adds ~10kb to every page that uses crmUi (ie every Angular page in Civi), which seems a little gratuitious for production page-views. Alas, the angularDebug=1 preference is a client-side thing that we don't know about server-side, so there's no way to anticipate if it's worth sending.

As a mitigation, this patch consults the global debug setting (Civi::setting()->get('debug_enabled')):

• If the server has debug enabled, then it sends the pretty-print library.
• If the server does not have debug enabled, then it sends the el-cheapo version (<pre>{{myData|json}}</pre>).

CC @colemanw @seamuslee001

[civibot]

(Standard links)

• If this is your first pull-request for CiviCRM, please browse CONTRIBUTING.md for information about the development and testing processes.
• If you are reviewing this pull-request, you may wish to consult the test sites and the Review Standards (long template, short template).

[colemanw]

Looks good @totten but I think test failures relate

[totten]

@colemanw Indeed it is. Rebased.

[colemanw]

@totten one more failure...

[colemanw]

The coupling between $isDebug and the ability of this thing to function feels hack-ish to me. For the purposes at hand, sure it makes sense, but what if some other module wanted this functionality for purposes other than debugging? I might even have a use for it in search kit.

[colemanw]

I don't want to trigger more work with that comment. This whole PR feels like a low-priority side-project and we should get back to the main tasks. If you fix the test I'll merge it as-is.

[totten]

Yeah, I can see how jsonFormatter could also be useful in admin/site-builder tooling.

Found a way to remove the jsonFormatter stub. With the update, jsonFormatter works like a regular module. (So if you want to use, then just... require it...) The optimization bit is now in crmUiDebug, which has a soft-requirement jsonFormatter.

Tangentially, jsonFormatter will also autoload now if used by an afform.