INT-1242 improve maxTimeMS behavior

3 states:
- maxTimeMS hits without any documents returned
- maxTimeMS hits but partial documents have already been returned
- sampling takes longer but maxTimeMS is not reached (this case is possible because maxTimeMS counts only operational time spent actively working on the database, not wall time)

Author: rueckstiess

package.json

@@ -87,7 +87,7 @@
     "mongodb-js-metrics": "^1.0.0",
     "mongodb-language-model": "^0.3.3",
     "mongodb-ns": "^1.0.3",
-    "mongodb-schema": "^4.1.0",
+    "mongodb-schema": "^4.2.0",
     "ms": "^0.7.1",
     "node-notifier": "^4.3.1",
     "numeral": "^1.5.3",

src/app/models/sampled-schema.js

@@ -106,7 +106,6 @@ module.exports = Schema.extend({
       if (success) {
         success(model, resp, options);
       }
-      model.trigger('sync');
     };
 
     var start = new Date();
@@ -159,6 +158,7 @@ module.exports = Schema.extend({
         'total analysis time': totalTime - timeToFirstDoc,
         'average analysis time per doc': (totalTime - timeToFirstDoc) / sampleCount
       });
+      model.trigger('sync');
       options.success({});
     };
 
@@ -174,8 +174,6 @@ module.exports = Schema.extend({
         return options.success({});
       }
 
-      debug('count', count);
-
       var status = 0;
       var numSamples = Math.min(options.size, count);
       var stepSize = Math.ceil(Math.max(1, numSamples / 10));
@@ -215,14 +213,10 @@ module.exports = Schema.extend({
           schemaStatusSubview.error = true;
           onFail(analysisErr);
         })
-        .on('data', function() {
-          if (sampleCount >= numSamples) {
+        .on('end', function() {
+          if (sampleCount === numSamples) {
             return onEnd();
           }
-          // workaround, as 'data' seems to be emitted even when sample stage
-          // has an error. @ChristianKvalheim investigating.
-          debug('did not receive data from the driver.');
-          onFail(new Error('did not receive data from driver.'));
         });
     });
   },
@@ -231,17 +225,13 @@ module.exports = Schema.extend({
     this.fetch();
   },
   stopAnalyzing: function() {
-    if (!this.is_fetching) {
-      return;
+    if (this.is_fetching) {
+      this.is_fetching = false;
+      this.samplingStream.destroy();
+      this.analyzingStream.destroy();
     }
-    this.is_fetching = false;
-    // @todo thomasr, uncomment this line once we figured out why
-    // app.client.sample() is not emitting any events anymore.
-    // for now, we can use app.client.find instead.
-
-    // this.samplingStream.destroy();
-    this.analyzingStream.destroy();
     app.statusbar.hide(true);
+    this.trigger('sync');
   },
   serialize: function() {
     var res = this.getAttributes({

src/app/statusbar/schema-subview.jade

@@ -10,7 +10,7 @@ div#schema-status-subview
         | Analyzing Documents
 
   div.buttons(data-hook='buttons')
-    div#buttons-sampling
+    div#buttons-error
       div.alert.alert-warning(role='alert', data-hook='sampling-info')
         | Sampling took longer than 
         span(data-hook='maxtimems') 10 seconds
@@ -20,9 +20,9 @@ div#schema-status-subview
           i.fa.fa-fw.fa-info-circle
       br
       div.btn.btn-info(data-hook='increase-maxtimems-button') Try for 1 minute
-      div.btn.btn-info(data-hook='create-new-query-button') Create new query
+      div.btn.btn-info(data-hook='next-action-button')
 
-    div#buttons-analyzing
+    div#buttons-waiting
       div.alert.alert-info(role='alert', data-hook='analyzing-info') Document analysis is taking longer than expected.  
         a.help(data-hook='schema-long-running-queries')
           | Learn More

src/app/statusbar/schema-subview.js

@@ -9,7 +9,7 @@ var subviewTemplate = jade.compileFile(path.resolve(__dirname, 'schema-subview.j
 
 
 var SHOW_STEPS_MS = 3000;
-var SHOW_ANALYZING_BUTTONS_MS = 10000;
+var SHOW_ANALYZING_BUTTONS_MS = app.queryOptions.maxTimeMS + 1000;
 
 module.exports = View.extend({
   template: subviewTemplate,
@@ -41,6 +41,13 @@ module.exports = View.extend({
     }
   },
   derived: {
+    nextActionLabel: {
+      deps: ['activeStep'],
+      fn: function() {
+        return this.activeStep === 'sampling' ?
+          'Create new Query' : 'Show partial results';
+      }
+    },
     samplingState: {
       deps: ['activeStep', 'error'],
       fn: function() {
@@ -67,6 +74,10 @@ module.exports = View.extend({
     }
   },
   bindings: {
+    nextActionLabel: {
+      hook: 'next-action-button',
+      type: 'text'
+    },
     stepsVisible: {
       type: 'toggle',
       hook: 'steps',
@@ -77,15 +88,20 @@ module.exports = View.extend({
       hook: 'buttons',
       mode: 'visibility'
     },
+    error: {
+      type: 'toggle',
+      no: '#buttons-waiting',
+      yes: '#buttons-error'
+    },
     activeStep: [
-      {
-        type: 'switch',
-        hook: 'buttons',
-        cases: {
-          sampling: '#buttons-sampling',
-          analyzing: '#buttons-analyzing'
-        }
-      },
+      // {
+      //   type: 'switch',
+      //   hook: 'buttons',
+      //   cases: {
+      //     sampling: '#buttons-sampling',
+      //     analyzing: '#buttons-analyzing'
+      //   }
+      // },
       {
         type: 'switchClass',
         name: 'is-active',
@@ -123,7 +139,8 @@ module.exports = View.extend({
   },
   events: {
     'click [data-hook=stop-analyzing-button]': 'stopAnalyzingClicked',
-    'click [data-hook=create-new-query-button]': 'createNewQueryClicked',
+    'click [data-hook=partial-results-button]': 'stopAnalyzingClicked',
+    'click [data-hook=next-action-button]': 'nextActionClicked',
     'click [data-hook=increase-maxtimems-button]': 'resampleWithLongerTimoutClicked'
   },
   render: function() {
@@ -150,7 +167,10 @@ module.exports = View.extend({
   resampleWithLongerTimoutClicked: function() {
     this.schema.reSampleWithLongerTimeout();
   },
-  createNewQueryClicked: function() {
+  nextActionClicked: function() {
+    if (this.schema && this.schema.count > 0) {
+      return this.schema.stopAnalyzing();
+    }
     app.statusbar.hide();
   },
   remove: function() {