[MSG OK] better error handling between server-side graph generation and the...

[MSG OK] better error handling between server-side graph generation and the error messages shown on client-side

graph/graph.py

@@ -78,6 +78,14 @@ def get_graph( request=None         , corpus=None
     after_cooc = datetime.now()
     print("... Cooccurrences took %f s." % (after_cooc - before_cooc).total_seconds())
 
+
+    # case when 0 coocs are observed (usually b/c not enough ngrams in maplist)
+    if len(cooc_matrix.items) == 0:
+        print("GET_GRAPH: 0 coocs in matrix")
+        data = {'nodes':[], 'links':[]}  # empty data
+
+    # normal case
+    else:
         G, partition, ids, weight = clusterByDistances ( cooc_matrix
                                                        , field1="ngrams", field2="ngrams"
                                                        , distance=distance

graph/rest.py

@@ -6,6 +6,8 @@ from graph.graph             import get_graph
 from gargantext.util.http    import APIView, APIException\
                                   , JsonHttpResponse, requires_auth
 
+from traceback import format_tb
+
 # TODO check authentication
 
 class Graph(APIView):
@@ -54,6 +56,7 @@ class Graph(APIView):
             mapList_id = mapList_id[0]
 
             if mapList_id == None :
+                # todo add as an error msg ?
                 raise ValueError("MAPLIST node needed for cooccurrences")
 
 
@@ -69,19 +72,19 @@ class Graph(APIView):
             groupList_id  = groupList_id[0]
 
             if groupList_id == None :
+                # todo add as an error msg ?
                 raise ValueError("GROUPLIST node needed for cooccurrences")
 
 
-        # Chec the options
+        # Check the options
         accepted_field1 = ['ngrams', 'journal', 'source', 'authors']
         accepted_field2 = ['ngrams',                               ]
         options         = ['start', 'end', 'threshold', 'distance', 'cooc_id' ]
 
 
-        # Test function
-
-        if field1 in accepted_field1 :
-            if field2 in accepted_field2 :
+        try:
+            # Test params
+            if (field1 in accepted_field1) and (field2 in accepted_field2):
                 if start is not None and end is not None :
                     data = get_graph( corpus=corpus, cooc_id = cooc_id
                                   #, field1=field1           , field2=field2
@@ -97,12 +100,31 @@ class Graph(APIView):
                                    , distance   = distance
                                    , bridgeness = bridgeness
                                    )
+                # Test data length
+                if len(data['nodes']) > 0 and len(data['links']) > 0:
+                    # normal case --------------------------------
                     if format_ == 'json':
-                    return JsonHttpResponse(data)
+                        return JsonHttpResponse(data, status=200)
+                    # --------------------------------------------
                 else:
+                    # empty data case
+                    return JsonHttpResponse({
+                        'msg': '''Empty graph warning
+                                  No cooccurences found in this corpus for the words of this maplist
+                                  (maybe add more terms to the maplist?)''',
+                        }, status=400)
+            else:
+                # parameters error case
+                return JsonHttpResponse({
+                    'msg': '''Usage warning
+                              Please choose only one field from each range:
+                                - "field1": %s
+                                - "field2": %s
+                                - "options": %s''' % (accepted_field1, accepted_field2, options)
+                    }, status=400)
+
+        # for any other errors that we forgot to test
+        except Exception as e:
             return JsonHttpResponse({
-                'Warning USAGE' : 'One field for each range:'
-                , 'field1' : accepted_field1
-                , 'field2' : accepted_field2
-                , 'options': options
-                })
+                'msg' : 'Unknown error (showing the trace):\n%s' % "\n".join(format_tb(e.__traceback__))
+                }, status=400)

static/lib/graphExplorer/example_start_explorer.html

@@ -357,6 +357,27 @@
       </div>
     </div>
 
+    <div id="errormodal" class="modal fade">
+      <div class="modal-dialog">
+        <div class="modal-content">
+
+          <div class="modal-header">
+            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
+            <h4 class="modal-title">Graph generation error</h4>
+          </div>
+
+          <div class="modal-body form-horizontal">
+            <div id="errormsg"></div>
+          </div>
+
+          <div class="modal-footer">
+            <button type="button" class="btn btn-default" data-dismiss="modal">Ok</button>
+          </div>
+
+        </div>
+      </div>
+    </div>
+
 
     <div id="modalloader" class="modal fade">
         <div id="loader" class="loader">

static/lib/graphExplorer/tinawebJS/main.js

@@ -76,25 +76,32 @@ $.ajax({
         success : function(data, textStatus, jqXHR) {
             header = jqXHR.getResponseHeader("Content-Type")
             header = (header)?"json":"gexf";
-            Result = { "OK":true , "format":header , "data":data };
+            Result = { "format":header , "data":data };
             MainFunction( Result )
         },
         error: function(exception) {
-            Result = { "OK":false , "format":false , "data":exception.status };
-            MainFunction( Result )
+            // console.warn(JSON.stringify(exception, null, 2))
+            showErrorDialog(file, exception.status, exception.responseJSON.msg)
         }
 });
 
+function showErrorDialog(url, status, msg) {
+    console.log('FUN t.main:showErrorDialog')
+    // hide loader gif etc
+    $("#semLoader").hide();
+    $("#closeloader").click();
+
+    // copy message content
+    $('#errormsg').html(msg.replace(/\n/g, '<br/>'))
+
+    // show the dialog box
+    $('#errormodal').modal('show');
+}
+
 function MainFunction( RES ) {
     console.log('           ------------')
     console.log('FUN t.main:MainFunction')
     console.log('           ------------')
-    if(!RES["OK"]) {
-        alert("error: "+RES["data"])
-        return false;
-    }
-
-
     var fileparam;// = { db|api.json , somefile.json|gexf }
     var the_data = RES["data"];
 

templates/graphExplorer/explorer.html

@@ -362,7 +362,26 @@
       </div>
     </div>
 
+    <div id="errormodal" class="modal fade">
+      <div class="modal-dialog">
+        <div class="modal-content">
+
+          <div class="modal-header">
+            <button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button>
+            <h4 class="modal-title">Graph generation error</h4>
+          </div>
 
+          <div class="modal-body form-horizontal">
+            <div id="errormsg"></div>
+          </div>
+
+          <div class="modal-footer">
+            <button type="button" class="btn btn-default" data-dismiss="modal">Ok</button>
+          </div>
+
+        </div>
+      </div>
+    </div>
 
     <div id="corpuses" class="modal fade">