NEW Add a trace comment for queries in dev mode

[GuySartorelli]

Issue

• Add an SQL comment in dev mode showing where queries were executed #11064

[GuySartorelli]

mariadb failure is unrelated.

[GuySartorelli]

Rebased to resolve that old mariadb failure

[emteknetnz]

Try installing debugbar - it also shows where sql originated from, though in some cases there were different results

Either this is correct and debugbar is wrong, or vice versa

Also there were some cases where debugbar was getting the source from and this wasn't

Possibly just copy whatever debugbar does?

Also probably exclude running this code if debugbar is running, as there's no need to output where the call originates from twice

[GuySartorelli]

Try installing debugbar - it also shows where sql originated from, though in some cases there were different results
Either this is correct and debugbar is wrong, or vice versa

Looks like both were wrong 😅
I've made the tracing more robust here. See lekoala/silverstripe-debugbar#152 for the problem in debugbar.

Also there were some cases where debugbar was getting the source from and this wasn't

I've identified a couple of scenarios where that happens - one is Permission::permissions_for_member() and the other is Versioned::determineVersionNumberByStage(). Both of those skip this code, by making truly raw SQL queries. In those cases, I don't think we should try to be clever and inject stuff into the query - if it's a truly raw query like this it should be left untouched. Probably we should update those queries to use the ORM but that's not in scope for this card.

Also probably exclude running this code if debugbar is running, as there's no need to output where the call originates from twice

I'm not going to add coupling from framework to debugbar. I'll was going to open a card in debugbar to strip these comments since it has its own way of pointing to the query origin - but now that this PR introduces config to opt into the trace comment, developers should just not opt in if they're using debugbar.

[emteknetnz]

Noticed a handful of queries not getting comments when running ?showqueries=1 inside the cms

0008: SELECT "Code" FROM "Permission" WHERE "Type" = 1 AND "GroupID" IN (2) UNION SELECT "Code" FROM "PermissionRoleCode" PRC INNER JOIN "PermissionRole" PR ON PRC."RoleID" = PR."ID" INNER JOIN "Group_Roles" GR ON GR."PermissionRoleID" = PR."ID" WHERE "GroupID" IN (2) 0.0003s 

0009: SELECT "Code" FROM "Permission" WHERE "Type" = -1 AND "GroupID" IN (2) 0.0001s 

0014: SELECT "ID", "Version" FROM "SiteTree" 0.0001s 

0015: SELECT "ID", "Version" FROM "SiteTree_Live" 0.0001s 

Also I think this is worth being to be able to enable via an environment variable so that platform engineers can switch it on more easily

[GuySartorelli]

I've removed the withEnvironmentType() stuff now, since we're using config and environment variables to control whether comments are included or not.

[GuySartorelli]

Noticed a handful of queries not getting comments when running ?showqueries=1 inside the cms

I addressed that in #11065 (comment)

Also I think this is worth being to be able to enable via an environment variable so that platform engineers can switch it on more easily

Done