dives into publish_result
[myslice.git] / manifold / js / manifold.js
index bd34726..726e68f 100644 (file)
@@ -51,7 +51,8 @@ var SET_REMOVED    = 202;
 var FIELD_REQUEST_CHANGE  = 301;
 var FIELD_REQUEST_ADD     = 302;
 var FIELD_REQUEST_REMOVE  = 303;
-var FIELD_REQUEST_RESET   = 304;
+var FIELD_REQUEST_ADD_RESET = 304;
+var FIELD_REQUEST_REMOVE_RESET = 305;
 // status
 var FIELD_REQUEST_PENDING = 401;
 var FIELD_REQUEST_SUCCESS = 402;
@@ -103,10 +104,9 @@ function QueryStore() {
 
     /* Insertion */
 
-    this.insert = function(query)
-    {
+    this.insert = function(query) {
         // We expect only main_queries are inserted
-
+       
         /* If the query has not been analyzed, then we analyze it */
         if (query.analyzed_query == null) {
             query.analyze_subqueries();
@@ -157,23 +157,19 @@ function QueryStore() {
 
     /* Searching */
 
-    this.find_query_ext = function(query_uuid)
-    {
+    this.find_query_ext = function(query_uuid) {
         return this.main_queries[query_uuid];
     }
 
-    this.find_query = function(query_uuid)
-    {
+    this.find_query = function(query_uuid) {
         return this.find_query_ext(query_uuid).query;
     }
 
-    this.find_analyzed_query_ext = function(query_uuid)
-    {
+    this.find_analyzed_query_ext = function(query_uuid) {
         return this.analyzed_queries[query_uuid];
     }
 
-    this.find_analyzed_query = function(query_uuid)
-    {
+    this.find_analyzed_query = function(query_uuid) {
         return this.find_analyzed_query_ext(query_uuid).query;
     }
 }
@@ -203,8 +199,7 @@ var manifold = {
         } catch (err) { messages.debug("Cannot turn spins on/off " + err); }
     },
 
-    get_type: function(variable)
-    {
+    get_type: function(variable) {
         switch(Object.toType(variable)) {
             case 'number':
             case 'string':
@@ -225,14 +220,12 @@ var manifold = {
 
      metadata: {
 
-        get_table: function(method)
-        {
+        get_table: function(method) {
             var table = MANIFOLD_METADATA[method];
             return (typeof table === 'undefined') ? null : table;
         },
 
-        get_columns: function(method)
-        {
+        get_columns: function(method) {
             var table = this.get_table(method);
             if (!table) {
                 return null;
@@ -241,8 +234,7 @@ var manifold = {
             return (typeof table.column === 'undefined') ? null : table.column;
         },
 
-        get_key: function(method)
-        {
+        get_key: function(method) {
             var table = this.get_table(method);
             if (!table)
                 return null;
@@ -251,8 +243,7 @@ var manifold = {
         },
 
 
-        get_column: function(method, name)
-        {
+        get_column: function(method, name) {
             var columns = this.get_columns(method);
             if (!columns)
                 return null;
@@ -264,8 +255,7 @@ var manifold = {
             return null;
         },
 
-        get_type: function(method, name)
-        {
+        get_type: function(method, name) {
             var table = this.get_table(method);
             if (!table)
                 return null;
@@ -324,21 +314,22 @@ var manifold = {
     // trigger a query asynchroneously
     proxy_url : '/manifold/proxy/json/',
 
+    // reasonably low-noise, shows manifold requests coming in and out
     asynchroneous_debug : true,
+    // print our more details on result publication and related callbacks
+    publish_result_debug : false,
 
     /**
      * \brief We use js function closure to be able to pass the query (array)
      * to the callback function used when data is received
      */
-    success_closure: function(query, publish_uuid, callback /*domid*/)
-    {
+    success_closure: function(query, publish_uuid, callback /*domid*/) {
         return function(data, textStatus) {
             manifold.asynchroneous_success(data, query, publish_uuid, callback /*domid*/);
         }
     },
 
-    run_query: function(query, callback)
-    {
+    run_query: function(query, callback) {
         // default value for callback = null
         if (typeof callback === 'undefined')
             callback = null; 
@@ -383,7 +374,8 @@ var manifold = {
 
             // not quite sure what happens if we send a string directly, as POST data is named..
             // this gets reconstructed on the proxy side with ManifoldQuery.fill_from_POST
-                jQuery.post(manifold.proxy_url, {'json':query_json} , manifold.success_closure(query, publish_uuid, tuple.callback /*domid*/));
+            jQuery.post(manifold.proxy_url, {'json':query_json}, 
+                       manifold.success_closure(query, publish_uuid, tuple.callback /*domid*/));
         })
     },
 
@@ -396,7 +388,8 @@ var manifold = {
      */
     forward: function(query, callback /*domid*/) {
         var query_json = JSON.stringify(query);
-        $.post(manifold.proxy_url, {'json': query_json} , manifold.success_closure(query, query.query_uuid, callback/*domid*/));
+        $.post(manifold.proxy_url, {'json': query_json} , 
+              manifold.success_closure(query, query.query_uuid, callback/*domid*/));
     },
 
     /*!
@@ -426,17 +419,22 @@ var manifold = {
 
         // NEW PLUGIN API
         manifold.raise_record_event(query.query_uuid, CLEAR_RECORDS);
+        if (manifold.publish_result_debug) messages.debug(".. publish_result (1) ");
+       var count=0;
         $.each(result, function(i, record) {
             manifold.raise_record_event(query.query_uuid, NEW_RECORD, record);
+           count += 1;
         });
+        if (manifold.publish_result_debug) messages.debug(".. publish_result NEW API (2) count=" + count);
         manifold.raise_record_event(query.query_uuid, DONE);
 
         // OLD PLUGIN API BELOW
         /* Publish an update announce */
         var channel="/results/" + query.query_uuid + "/changed";
-        if (manifold.asynchroneous_debug)
-            messages.debug("publishing result on " + channel);
+        if (manifold.publish_result_debug) messages.debug(".. publish_result OLD API (3) " + channel);
         jQuery.publish(channel, [result, query]);
+
+       if (manifold.publish_result_debug) messages.debug(".. publish_result - END (4) q=" + query.__repr());
     },
 
     /*!
@@ -451,6 +449,7 @@ var manifold = {
          * otherwise, publish the main object as well as subqueries
          * XXX how much recursive are we ?
          */
+       if (manifold.publish_result_debug) messages.debug (">>>>> publish_result_rec " + query.object);
         if (manifold.query_expects_unique_result(query)) {
             /* Also publish subqueries */
             jQuery.each(query.subqueries, function(object, subquery) {
@@ -458,11 +457,12 @@ var manifold = {
                 /* TODO remove object from result */
             });
         }
+       if (manifold.publish_result_debug) messages.debug ("===== publish_result_rec " + query.object);
         manifold.publish_result(query, result);
+       if (manifold.publish_result_debug) messages.debug ("<<<<< publish_result_rec " + query.object);
     },
 
-    setup_update_query: function(query, records)
-    {
+    setup_update_query: function(query, records) {
         // We don't prepare an update query if the result has more than 1 entry
         if (records.length != 1)
             return;
@@ -506,8 +506,7 @@ var manifold = {
         }
     },
 
-    process_get_query_records: function(query, records)
-    {
+    process_get_query_records: function(query, records) {
         this.setup_update_query(query, records);
 
         /* Publish full results */
@@ -529,8 +528,7 @@ var manifold = {
      * diff's. This means we need to move the publish functionalities in the
      * previous 'process_get_query_records' function.
      */
-    process_update_query_records: function(query, records)
-    {
+    process_update_query_records: function(query, records) {
         // First issue: we request everything, and not only what we modify, so will will have to ignore some fields
         var query_uuid        = query.query_uuid;
         var query_ext         = manifold.query_store.find_analyzed_query_ext(query_uuid);
@@ -688,8 +686,7 @@ var manifold = {
         this.setup_update_query(query, records);
     },
 
-    process_query_records: function(query, records)
-    {
+    process_query_records: function(query, records) {
         if (query.action == 'get') {
             this.process_get_query_records(query, records);
         } else if (query.action == 'update') {
@@ -703,14 +700,29 @@ var manifold = {
     // e.g. an updater wants to publish its result as if from the original (get) query
     asynchroneous_success : function (data, query, publish_uuid, callback /*domid*/) {
         // xxx should have a nicer declaration of that enum in sync with the python code somehow
+       
+       var start = new Date();
+       if (manifold.asynchroneous_debug)
+           messages.debug(">>>>>>>>>> asynchroneous_success query.object=" + query.object);
 
         /* If a callback has been specified, we redirect results to it */
-        if (!!callback) { callback(data); return; }
+        if (!!callback) { 
+           callback(data); 
+           if (manifold.asynchroneous_debug) {
+               duration=new Date()-start;
+               messages.debug ("<<<<<<<<<< asynchroneous_success " + query.object + " -- callback ended " + duration + " ms");
+           }
+           return; 
+       }
 
         if (data.code == 2) { // ERROR
             // We need to make sense of error codes here
             alert("Your session has expired, please log in again");
             window.location="/logout/";
+           if (manifold.asynchroneous_debug) {
+               duration=new Date()-start;
+               messages.debug ("<<<<<<<<<< asynchroneous_success " + query.object + " -- error returned - logging out " + duration + " ms");
+           }
             return;
         }
         if (data.code == 1) { // WARNING
@@ -728,6 +740,9 @@ var manifold = {
             });
             
         }
+       if (manifold.asynchroneous_debug) 
+           messages.debug ("========== asynchroneous_success " + query.object + " -- before process_query_records");
+
         // once everything is checked we can use the 'value' part of the manifoldresult
         var result=data.value;
         if (result) {
@@ -738,40 +753,42 @@ var manifold = {
             //tmp_query = manifold.find_query(query.query_uuid);
             //manifold.publish_result_rec(tmp_query.analyzed_query, result);
         }
+       if (manifold.asynchroneous_debug) {
+           duration=new Date()-start;
+           messages.debug ("<<<<<<<<<< asynchroneous_success " + query.object + " -- done " + duration + " ms");
+       }
+
     },
 
     /************************************************************************** 
      * Plugin API helpers
      **************************************************************************/ 
 
-    raise_event_handler: function(type, query_uuid, event_type, value)
-    {
+    raise_event_handler: function(type, query_uuid, event_type, value) {
         if ((type != 'query') && (type != 'record'))
             throw 'Incorrect type for manifold.raise_event()';
 
         var channels = [ manifold.get_channel(type, query_uuid), manifold.get_channel(type, '*') ];
 
         $.each(channels, function(i, channel) {
-            if (value === undefined)
+            if (value === undefined) {
                 $('.plugin').trigger(channel, [event_type]);
-            else
+           } else {
                 $('.plugin').trigger(channel, [event_type, value]);
+           }
         });
     },
 
-    raise_query_event: function(query_uuid, event_type, value)
-    {
+    raise_query_event: function(query_uuid, event_type, value) {
         manifold.raise_event_handler('query', query_uuid, event_type, value);
     },
 
-    raise_record_event: function(query_uuid, event_type, value)
-    {
+    raise_record_event: function(query_uuid, event_type, value) {
         manifold.raise_event_handler('record', query_uuid, event_type, value);
     },
 
 
-    raise_event: function(query_uuid, event_type, value)
-    {
+    raise_event: function(query_uuid, event_type, value) {
         // Query uuid has been updated with the key of a new element
         query_ext    = manifold.query_store.find_analyzed_query_ext(query_uuid);
         query = query_ext.query;
@@ -795,19 +812,20 @@ var manifold = {
                         break;
                     case FIELD_REQUEST_ADD:
                         if ($.inArray(value.value, update_query_orig.params[value.key]) != -1)
-                            value.request = FIELD_REQUEST_RESET;
+                            value.request = FIELD_REQUEST_ADD_RESET;
                         update_query.params[value.key].push(value.value);
                         break;
                     case FIELD_REQUEST_REMOVE:
                         if ($.inArray(value.value, update_query_orig.params[value.key]) == -1)
-                            value.request = FIELD_REQUEST_RESET;
+                            value.request = FIELD_REQUEST_REMOVE_RESET;
 
                         var arr = update_query.params[value.key];
                         arr = $.grep(arr, function(x) { return x != value.value; });
                         update_query.params[value.key] = arr;
 
                         break;
-                    case FIELD_REQUEST_RESET:
+                    case FIELD_REQUEST_ADD_RESET:
+                    case FIELD_REQUEST_REMOVE_RESET:
                         // XXX We would need to keep track of the original query
                         throw "Not implemented";
                         break;
@@ -818,6 +836,21 @@ var manifold = {
                 manifold.raise_record_event(query_uuid, event_type, value);
 
                 // b) subqueries eventually (dot in the key)
+                // Let's unfold 
+                var path_array = value.key.split('.');
+                var value_key = value.key.split('.');
+
+                var cur_query = query;
+                if (cur_query.analyzed_query)
+                    cur_query = cur_query.analyzed_query;
+                $.each(path_array, function(i, method) {
+                    cur_query = cur_query.subqueries[method];
+                    value_key.shift(); // XXX check that method is indeed shifted
+                });
+                value.key = value_key;
+
+                manifold.raise_record_event(cur_query.query_uuid, event_type, value);
+
                 // XXX make this DOT a global variable... could be '/'
                 break;
 
@@ -859,7 +892,8 @@ var manifold = {
                 // NOTE : we have to modify all child queries
                 // NOTE : parts of a query might not be started (eg slice.measurements, how to handle ?)
 
-                // if everything is done right, update_query should not be null. It is updated when we received results from the get query
+                // if everything is done right, update_query should not be null. 
+               // It is updated when we received results from the get query
                 // object = the same as get
                 // filter = key : update a single object for now
                 // fields = the same as get
@@ -917,8 +951,7 @@ var manifold = {
     },
 
     /* Publish/subscribe channels for internal use */
-    get_channel: function(type, query_uuid) 
-    {
+    get_channel: function(type, query_uuid) {
         if ((type !== 'query') && (type != 'record'))
             return null;
         return '/' + type + '/' + query_uuid;
@@ -1005,4 +1038,3 @@ $.ajaxSetup({
          }
      } 
 });
-