# HG changeset patch
# User Laurent Peuch <cortex@worlddomination.be>
# Date 1571891822 -7200
# Node ID ec834074ea25983246cb5d0a64d36f611c3dd9cd
# Parent  db95a417a5ecc5abc7107c7b8432a5d501e1ce9c
[debug/emit/rql] add RQL debug channel and emit queries

This is used for the RQL debug panel but can be used as a generic mechanism for
several tools.

diff -r db95a417a5ec -r ec834074ea25 cubicweb/server/querier.py
--- a/cubicweb/server/querier.py	Wed Nov 06 14:43:49 2019 +0100
+++ b/cubicweb/server/querier.py	Thu Oct 24 06:37:02 2019 +0200
@@ -19,6 +19,8 @@
 security checking and data aggregation.
 """
 import uuid
+import time
+import traceback
 from itertools import repeat
 
 from rql import RQLSyntaxError, CoercionError
@@ -30,6 +32,7 @@
 from cubicweb.rqlrewrite import RQLRelationRewriter
 from cubicweb import Binary, server
 from cubicweb.rset import ResultSet
+from cubicweb.debug import emit_to_debug_channel
 
 from cubicweb.utils import QueryCache, RepeatList
 from cubicweb.misc.source_highlight import highlight_terminal
@@ -558,6 +561,18 @@
         plan.cache_key = cachekey
         plan.rql_query_tracing_token = str(uuid.uuid4())
         self._planner.build_plan(plan)
+
+        query_debug_informations = {
+            "rql": rql,
+            "rql_query_tracing_token": plan.rql_query_tracing_token,
+            "args": args,
+            # remove the last part of the stack which is: this line
+            "callstack": "".join(traceback.format_stack()[:-1]),
+            "description": "",
+        }
+
+        start = time.time()
+
         # execute the plan
         try:
             results = plan.execute()
@@ -573,6 +588,10 @@
             if cnx.commit_state is None:
                 cnx.commit_state = 'uncommitable'
             raise
+
+        query_debug_informations["time"] = ((time.time() - start) * 1000)
+        query_debug_informations["result"] = results
+
         # build a description for the results if necessary
         descr = ()
         if build_descr:
@@ -596,6 +615,10 @@
                 descr = _build_descr(cnx, results, basedescr, todetermine)
             # FIXME: get number of affected entities / relations on non
             # selection queries ?
+            query_debug_informations["description"] = descr
+
+        emit_to_debug_channel("rql", query_debug_informations)
+
         # return a result set object
         return ResultSet(results, rql, args, descr)