linny-r 1.6.7 → 1.7.0

package/static/scripts/linny-r-gui-controller.js

@@ -443,12 +443,13 @@ class GUIController extends Controller {
     // Keep track of time since last message displayed on the infoline.
     this.time_last_message = new Date('01 Jan 2001 00:00:00 GMT');
     this.message_display_time = 3000;
+    this.last_message_type = '';
 
     // Initialize "main" modals, i.e., those that relate to the controller,
     // not to other dialog objects.
     const main_modals = ['logon', 'model', 'load', 'password', 'settings',
         'actors', 'add-process', 'add-product', 'move', 'note', 'clone', 
-        'replace', 'expression'];
+        'replace', 'expression', 'server', 'solver'];
     for(let i = 0; i < main_modals.length; i++) {
       this.modals[main_modals[i]] = new ModalDialog(main_modals[i]);
     }
@@ -580,8 +581,10 @@ class GUIController extends Controller {
       // NOTE: When user name is specified, solver is not on local host.
       const hl = document.getElementById('host-logo');
       hl.classList.add('local-server');
-      hl.addEventListener('click', () => UI.shutDownServer());
+      hl.addEventListener('click', () => UI.showServerModal());
     }
+    this.server_modal = new ModalDialog('server');
+    
 
     // Vertical tool bar buttons:
     this.buttons.clone.addEventListener('click',
@@ -703,10 +706,27 @@ class GUIController extends Controller {
             // Ensure that model documentation can no longer be edited.
             DOCUMENTATION_MANAGER.clearEntity([MODEL]);
           });
-    // Make the scale units button of the settings dialog responsive.
+    // Make the scale units and solver preferences buttons of the settings
+    // dialog responsive. Clicking will open these dialogs on top of the
+    // settings modal dialog.
     this.modals.settings.element('scale-units-btn').addEventListener('click',
-        // Open the scale units modal dialog on top of the settings dialog.
         () => SCALE_UNIT_MANAGER.show());
+    this.modals.settings.element('solver-prefs-btn').addEventListener('click',
+        () => UI.showSolverPreferencesDialog());
+    // Make solver modal elements responsive.
+    this.modals.solver.ok.addEventListener('click',
+        () => UI.updateSolverPreferences());
+    this.modals.solver.cancel.addEventListener('click',
+        () => UI.modals.solver.hide());
+    // Make server modal elements responsive.
+    this.modals.server.ok.addEventListener('click',
+        () => UI.changeSolver(UI.modals.server.element('solver').value));
+    this.modals.server.cancel.addEventListener('click',
+        () => UI.modals.server.hide());
+    this.modals.server.element('update').addEventListener('click',
+        () => UI.shutDownToUpdate());
+    this.modals.server.element('shut-down').addEventListener('click',
+        () => UI.shutDownServer());
 
     // Modals related to vertical toolbar buttons.
     this.modals['add-process'].ok.addEventListener('click',
@@ -795,7 +815,7 @@ class GUIController extends Controller {
     
     // The REPLACE dialog appears when a product is Ctrl-clicked.
     this.modals.replace.ok.addEventListener('click',
-        () => UI.replaceProduct());
+        () => UI.replaceProduct()); 
     this.modals.replace.cancel.addEventListener('click',
         () => UI.modals.replace.hide());
     
@@ -870,21 +890,25 @@ class GUIController extends Controller {
   }
 
   loadModelFromXML(xml) {
-    // Parses `xml` and updates the GUI 
+    // Parse `xml` and update the GUI.
     const loaded = MODEL.parseXML(xml);
-    // If not a valid Linny-R model, ensure that the current model is clean 
+    // If not a valid Linny-R model, ensure that the current model is clean.
     if(!loaded) MODEL = new LinnyRModel();
+    // If model specifies a preferred solver, immediately try to switch.
+    if(MODEL.preferred_solver !== VM.solver_name) {
+      UI.changeSolver(MODEL.preferred_solver);
+    }
     this.updateScaleUnitList();
     this.drawDiagram(MODEL);
-    // Cursor may have been set to `waiting` when decrypting
+    // Cursor may have been set to `waiting` when decrypting.
     this.normalCursor();
     this.setMessage('');
     this.updateButtons();
     // Undoable operations no longer apply!
     UNDO_STACK.clear();
-    // Autosaving should start anew
+    // Autosaving should start anew.
     AUTO_SAVE.setAutoSaveInterval();
-    // Signal success or failure
+    // Signal success or failure.
     return loaded;
   }
   
@@ -898,15 +922,15 @@ class GUIController extends Controller {
     MODEL.clearSelection();
     this.paper.drawModel(MODEL);
     this.updateButtons();
-    // NOTE: when "moving up" in the cluster hierarchy, bring the former focal
-    // cluster into view
+    // NOTE: When "moving up" in the cluster hierarchy, bring the former
+    // focal cluster into view.
     if(fc.cluster == MODEL.focal_cluster) {
       this.scrollIntoView(fc.shape.element.childNodes[0]);
     }
   }
   
   drawDiagram(mdl) {
-    // "Queue" a draw request (to avoid redrawing too often)
+    // "Queue" a draw request (to avoid redrawing too often).
     if(this.busy_drawing) {
       this.draw_requests += 1;
     } else {
@@ -952,19 +976,81 @@ class GUIController extends Controller {
       if(a.links.indexOf(link) >= 0) this.paper.drawArrow(a);
     }    
   }
+  
+  showServerModal() {
+    // Prepare and show the server modal dialog.
+    const
+        md = this.modals.server,
+        host = md.element('host-div'),
+        sd = md.element('solver-div'),
+        nsd = md.element('no-solver-div'),
+        html = [];
+    host.innerText = 'Server on ' + VM.server;
+    if(VM.server === 'local host') {
+      host.title = 'Linny-R directory is ' + VM.working_directory;
+    }
+    for(let i = 0; i < VM.solver_list.length; i++) {
+      const s = VM.solver_list[i];
+      html.push(['<option value="', s,
+          (s === VM.solver_name ? '"selected="selected' : ''),
+          '">', VM.solver_names[s], '</option>'].join(''));
+    }
+    md.element('solver').innerHTML = html.join('');
+    if(html.length) {
+      sd.style.display = 'block';
+      nsd.style.display = 'none';
+    } else {
+      sd.style.display = 'none';
+      nsd.style.display = 'block';
+    }
+    md.show();
+  }
+  
+  changeSolver(sid) {
+    // Change preferred solver to `sid` if specified.
+    if(!sid) return;
+    const
+        md = this.modals.server,
+        mps = MODEL.preferred_solver;
+    md.hide();
+    if(mps && mps !== sid) {
+      UI.warn('Model setttings designate ' + VM.solver_names[mps] +
+          ' as preferred solver');
+      return;
+    }
+    const pd = postData({action: 'change', solver: sid});
+    fetch('solver/', pd)
+      .then((response) => {
+          if(!response.ok) {
+            UI.alert(`ERROR ${response.status}: ${response.statusText}`);
+          }
+          return response.text();
+        })
+      .then((data) => {
+          if(UI.postResponseOK(data, true)) {
+            VM.solver_name = sid;
+            UI.modals.server.hide();
+          }
+        })
+      .catch((err) => {
+          UI.warn(UI.WARNING.NO_CONNECTION, err);
+        });
+  }
 
   shutDownServer() {
     // This terminates the local host server script and display a plain
     // HTML message in the browser with a restart button.
+    this.modals.server.hide();
     if(!SOLVER.user_id) window.open('./shutdown', '_self');
   }
 
   shutDownToUpdate() {
-    // Sisgnal server that an update is required. This will close the
+    // Signal server that an update is required. This will close the
     // local host Linny-R server. If this server was started by the
     // standard OS batch script, this script will proceed to update
     // Linny-R via npm and then restart the server again. If not, the
     // fetch request will time out, anf the user will be warned.
+    this.modals.server.hide();
     if(SOLVER.user_id) return;
     fetch('update/')
       .then((response) => {
@@ -1022,6 +1108,8 @@ class GUIController extends Controller {
                 `Linny-R version ${m[1]} has been installed.`,
                 'To continue, you must reload this page, and',
                 'confirm when prompted by your browser.');
+              // Hide "update" button in server dialog.
+              UI.modals.server.element('update').style.display = 'none';
             } else {
               // Inform user that install appears to have failed.
               msg.push(
@@ -1046,6 +1134,10 @@ class GUIController extends Controller {
   preventUpdate() {
     // Signal server that no update is required. 
     if(SOLVER.user_id) return;
+    // Show "update" button in server dialog to permit updating later.
+    const btn = this.modals.server.element('update');
+    btn.innerText = 'Update Linny-R to version ' + this.newer_version;
+    btn.style.display = 'block';
     fetch('no-update/')
       .then((response) => {
           if(!response.ok) {
@@ -2572,28 +2664,32 @@ class GUIController extends Controller {
     // Displays message on infoline unless no type (= plain text) and some
     // info, warning or error message is already displayed
     super.setMessage(msg, type);
+    const types = ['notification', 'warning', 'error'];
     let d = new Date(),
         t = d.getTime(),
-        dt = t - this.time_last_message;
+        dt = t - this.time_last_message,
+        mti = types.indexOf(type),
+        lmti = types.indexOf(this.last_message_type);
     if(type) {
-      // Update global variable (and force display) only for "real" messages
-      this.time_last_message = t;
-      dt = this.message_display_time;
-      SOUNDS[type].play().catch(() => {
-          console.log('NOTICE: Sounds will only play after first user action');
-        });
+      // Only log "real" messages.
       const
           now = [d.getHours(), d.getMinutes().toString().padStart(2, '0'),
               d.getSeconds().toString().padStart(2, '0')].join(':'),
           im = {time: now, text: msg, status: type};
       DOCUMENTATION_MANAGER.addMessage(im);
-      // When receiver is active, add message to its log
+      // When receiver is active, add message to its log.
       if(RECEIVER.active) RECEIVER.log(`[${now}] ${msg}`);
     }
-    // Display text only if previous message has "timed out" or was plain text
-    if(dt >= this.message_display_time) {
+    // Display text only if previous message has "timed out" or was less
+    // urgent than this one.
+    if(lmti < 0 || mti > lmti || dt >= this.message_display_time) {
+      this.time_last_message = t;
+      this.last_message_type = type;
+      if(type) SOUNDS[type].play().catch(() => {
+          console.log('NOTICE: Sounds will only play after first user action');
+        });
       const il = document.getElementById('info-line');
-      il.classList.remove('error', 'warning', 'notification');
+      il.classList.remove(...types);
       il.classList.add(type);
       il.innerHTML = msg;
     }
@@ -3516,6 +3612,53 @@ console.log('HERE name conflicts', name_conflicts, mapping);
     if(redraw) this.drawDiagram(model);
   }
   
+  // Solver preferences modal
+  
+  showSolverPreferencesDialog() {
+    const
+        md = this.modals.solver,
+        html = ['<option value="">(default)</option>'];
+    for(let i = 0; i < VM.solver_list.length; i++) {
+      const s = VM.solver_list[i];
+      html.push(['<option value="', s,
+          (s === MODEL.preferred_solver ? '"selected="selected' : ''),
+          '">', VM.solver_names[s], '</option>'].join(''));
+    }
+    md.element('preference').innerHTML = html.join('');
+    md.element('int-feasibility').value = MODEL.integer_tolerance;
+    md.element('mip-gap').value = MODEL.MIP_gap;
+    md.show();
+  }
+  
+  updateSolverPreferences() {
+    // Set values for solver preferences.
+    const
+        md = this.modals.solver,
+        it = md.element('int-feasibility'),
+        mg = md.element('mip-gap');
+    let itol = 5e-7,
+        mgap = 1e-4;
+    // Validate input, assuming default values for empty fields.
+    if(it.value.trim()) itol = UI.validNumericInput('solver-int-feasibility',
+        'integer feasibility tolerance');
+    if(itol === false) return false;
+    if(mg.value.trim()) mgap = UI.validNumericInput('solver-mip-gap',
+        'relative MIP gap');
+    if(mgap === false) return false;
+    // Modify solver preferences for the current model.
+    const ps = md.element('preference').value;
+    if(ps !== MODEL.preferred_solver) {
+      MODEL.preferred_solver = ps;
+      // Immediately try to change to the preferred solver, as this is
+      // an asynchronous call that may take time to complete.
+      UI.changeSolver(ps);
+    }
+    MODEL.integer_tolerance = Math.max(1e-9, Math.min(0.1, itol));
+    MODEL.MIP_gap = Math.max(0, Math.min(0.5, mgap));
+    // Close the dialog.
+    md.hide();
+  }
+  
   // Note modal
 
   showNotePropertiesDialog(n=null) {

package/static/scripts/linny-r-gui-monitor.js

@@ -326,13 +326,13 @@ class GUIMonitor {
           } else if(jsr.server) {
             VM.solver_token = jsr.token;
             VM.solver_name = jsr.solver;
-            // Remote solver may indicate user-specific solver time limit
+            // Remote solver may indicate user-specific solver time limit.
             let utl = '';
             if(jsr.time_limit) {
               VM.max_solver_time = jsr.time_limit;
               utl = ` -- ${VM.solver_name} solver: ` +
                   `max. ${VM.max_solver_time} seconds per block`;
-              // If user has a set time limit, no restrictions on tableau size
+              // If user has a set time limit, no restrictions on tableau size.
               VM.max_tableau_size = 0;
             }
             UI.notify('Logged on to ' + jsr.server + utl);
@@ -346,12 +346,15 @@ class GUIMonitor {
   }
 
   connectToServer() {
-    // Prompts for credentials if not connected yet
-    // NOTE: no authentication prompt if SOLVER.user_id in `linny-r-config.js`
-    // is left blank
+    // Prompts for credentials if not connected yet.
+    // NOTE: No authentication prompt if SOLVER.user_id in `linny-r-config.js`
+    // is left blank.
     if(!VM.solver_user) {
+      VM.connected = false;
       VM.solver_token = 'local host';
-      fetch('solver/', postData({action: 'logon'}))
+      fetch('solver/', postData({
+            action: 'logon',
+            solver: MODEL.preferred_solver || VM.solver_name}))
         .then((response) => {
             if(!response.ok) {
               UI.alert(`ERROR ${response.status}: ${response.statusText}`);
@@ -362,10 +365,15 @@ class GUIMonitor {
             try {
               const
                   jsr = JSON.parse(data),
-                  svr = `Solver on ${jsr.server} is ${jsr.solver}`;
-              if(jsr.solver !== VM.solver_name) UI.notify(svr);              
+                  sname = VM.solver_names[jsr.solver] || 'unknown',
+                  svr = `Solver on ${jsr.server} is ${sname}`;
+              if(jsr.solver !== VM.solver_name) UI.notify(svr);
+              VM.server = jsr.server;
+              VM.working_directory = jsr.path;
               VM.solver_name = jsr.solver;
+              VM.solver_list = jsr.solver_list;
               document.getElementById('host-logo').title  = svr;
+              VM.connected = true;
             } catch(err) {
               console.log(err, data);
               UI.alert('ERROR: Unexpected data from server: ' +
@@ -381,6 +389,7 @@ class GUIMonitor {
   }
 
   submitBlockToSolver() {
+    // Post MILP model plus relevant metadata to the server.
     let top = MODEL.timeout_period;
     if(VM.max_solver_time && top > VM.max_solver_time) {
       top = VM.max_solver_time;
@@ -398,7 +407,10 @@ UI.logHeapSize(`BEFORE creating post data`);
             round: VM.round_sequence[VM.current_round],
             columns: VM.columnsInBlock,
             data: VM.lines,
-            timeout: top
+            solver: MODEL.preferred_solver,
+            timeout: top,
+            inttol: MODEL.integer_tolerance,
+            mipgap: MODEL.MIP_gap
           });
 UI.logHeapSize(`AFTER creating post data`);
     // Immediately free the memory taken up by VM.lines