labextension start/stop works

use lists because dictionaries in javascript are too hard

load default clusters for profiles

Author: minrk

ipyparallel/cluster/cluster.py

@@ -740,6 +740,7 @@ def load_clusters(
         profile_dir=None,
         profiles=None,
         profile=None,
+        init_default_clusters=False,
         **kwargs,
     ):
         """Populate a ClusterManager from cluster files on disk
@@ -749,6 +750,10 @@ def load_clusters(
         Default is to find clusters in all IPython profiles,
         but profile directories or profile names can be specified explicitly.
 
+        If `init_default_clusters` is True,
+        a stopped Cluster object is loaded for every profile dir
+        with cluster_id="" if no running cluster is found.
+
         Priority:
 
         - profile_dirs list
@@ -772,8 +777,24 @@ def load_clusters(
                 # totally unspecified, default to all
                 profile_dirs = _all_profile_dirs()
 
+        by_cluster_file = {c.cluster_file: c for c in self._clusters.values()}
         for profile_dir in profile_dirs:
-            for cluster_file in self._cluster_files_in_profile_dir(profile_dir):
+            cluster_files = self._cluster_files_in_profile_dir(profile_dir)
+            # load default cluster for each profile
+            # TODO: only if it has any ipyparallel config files
+            # *or* it's the default profile
+            if init_default_clusters and not cluster_files:
+
+                cluster = Cluster(profile_dir=profile_dir, cluster_id="")
+                cluster_key = self._cluster_key(cluster)
+                if cluster_key not in self._clusters:
+                    self._clusters[cluster_key] = cluster
+
+            for cluster_file in cluster_files:
+                if cluster_file in by_cluster_file:
+                    # already loaded, skip it
+                    continue
+                self.log.debug(f"Loading cluster file {cluster_file}")
                 try:
                     cluster = Cluster.from_file(cluster_file, parent=self)
                 except Exception as e:

ipyparallel/nbextension/handlers.py

@@ -21,12 +21,24 @@ class ClusterHandler(APIHandler):
     def cluster_manager(self):
         return self.settings['cluster_manager']
 
-    def cluster_model(self, cluster):
-        """Create a JSONable cluster model"""
+    def cluster_model(self, key, cluster):
+        """Create a JSONable cluster model
+
+        Adds additional fields to make things easier on the client
+        """
         d = cluster.to_dict()
         profile_dir = d['cluster']['profile_dir']
         # provide abbreviated profile info
         d['cluster']['profile'] = abbreviate_profile_dir(profile_dir)
+
+        # top-level fields, added for easier client-side logic
+        # add 'id' key, since typescript is bad at key-value pairs
+        # so we return a list instead of a dict
+        d['id'] = key
+        # add total engine count
+        d['engines']['n'] = sum(es.get('n', 0) for es in d['engines']['sets'].values())
+        # add cluster file
+        d['cluster_file'] = cluster.cluster_file
         return d
 
 
@@ -39,18 +51,47 @@ class ClusterListHandler(ClusterHandler):
     @web.authenticated
     def get(self):
         # currently reloads everything from disk. Is that what we want?
-        clusters = self.cluster_manager.load_clusters()
-        self.finish(
-            {key: self.cluster_model(cluster) for key, cluster in clusters.items()}
+        clusters = self.cluster_manager.load_clusters(init_default_clusters=True)
+
+        def sort_key(model):
+            """Sort clusters
+
+            order:
+            - running
+            - default profile
+            - default cluster id
+            """
+            running = True if model.get("controller") else False
+            profile = model['cluster']['profile']
+            cluster_id = model['cluster']['cluster_id']
+            default_profile = profile == 'default'
+            default_cluster = cluster_id == ''
+
+            return (
+                not running,
+                not default_profile,
+                not default_cluster,
+                profile,
+                cluster_id,
+            )
+
+        self.write(
+            json.dumps(
+                sorted(
+                    [
+                        self.cluster_model(key, cluster)
+                        for key, cluster in clusters.items()
+                    ],
+                    key=sort_key,
+                )
+            )
         )
 
     @web.authenticated
     def post(self):
         body = self.get_json_body() or {}
-        # profile
-        # cluster_id
         cluster_id, cluster = self.cluster_manager.new_cluster(**body)
-        self.write(json.dumps({}))
+        self.write(json.dumps(self.cluster_model(cluster_id, cluster)))
 
 
 class ClusterActionHandler(ClusterHandler):
@@ -71,21 +112,24 @@ def get_cluster(self, cluster_key):
     @web.authenticated
     async def post(self, cluster_key):
         cluster = self.get_cluster(cluster_key)
-        n = self.get_argument('n', default=None)
+        body = self.get_json_body() or {}
+        n = body.get("n", None)
+        if n is not None and not isinstance(n, int):
+            raise web.HTTPError(400, f"n must be an integer, not {n!r}")
         await cluster.start_cluster(n=n)
-        self.write(json.dumps(self.cluster_model(cluster)))
+        self.write(json.dumps(self.cluster_model(cluster_key, cluster)))
 
     @web.authenticated
     async def get(self, cluster_key):
         cluster = self.get_cluster(cluster_key)
-        self.write(json.dumps(self.cluster_model(cluster)))
+        self.write(json.dumps(self.cluster_model(cluster_key, cluster)))
 
     @web.authenticated
     async def delete(self, cluster_key):
         cluster = self.get_cluster(cluster_key)
         await cluster.stop_cluster()
         self.cluster_manager.remove_cluster(cluster_key)
-        self.write(json.dumps(self.cluster_model(cluster)))
+        self.set_status(204)
 
 
 # -----------------------------------------------------------------------------

ipyparallel/nbextension/static/clusterlist.js

@@ -60,36 +60,31 @@ define(["base/js/namespace", "jquery", "base/js/utils"], function (
   ClusterList.prototype.load_list_success = function (data, status, xhr) {
     this.clear_list();
     var len = data.length;
-    console.log("cluster list", data);
-    for (var cluster_key in data) {
-      if (!data.hasOwnProperty(cluster_key)) {
-        continue;
-      }
+    for (var cluster of data) {
       var element = $("<div/>");
-      var item = new ClusterItem(element, cluster_key, this.options);
-      item.update_state(data[cluster_key]);
+      var item = new ClusterItem(element, cluster, this, this.options);
       element.data("item", item);
       this.element.append(element);
     }
   };
 
-  var ClusterItem = function (element, cluster_key, options) {
+  var ClusterItem = function (element, cluster, cluster_list, options) {
     this.element = $(element);
-    this.cluster_key = cluster_key;
+    this.cluster_list = cluster_list;
     this.base_url = options.base_url || utils.get_body_data("baseUrl");
     this.notebook_path =
       options.notebook_path || utils.get_body_data("notebookPath");
-    this.data = null;
+    this.update_state(cluster);
     this.style();
   };
 
   ClusterItem.prototype.style = function () {
     this.element.addClass("list_item").addClass("row");
   };
 
-  ClusterItem.prototype.update_state = function (data) {
-    this.data = data;
-    if (data.controller.state) {
+  ClusterItem.prototype.update_state = function (cluster) {
+    this.cluster = cluster;
+    if (cluster.controller && cluster.controller.state) {
       this.state_running();
     } else {
       this.state_stopped();
@@ -100,10 +95,10 @@ define(["base/js/namespace", "jquery", "base/js/utils"], function (
     var that = this;
     var profile_col = $("<div/>")
       .addClass("profile_col col-xs-2")
-      .text(this.data.profile);
+      .text(this.cluster.cluster.profile);
     var cluster_id_col = $("<div/>")
       .addClass("cluster_id_col col-xs-2")
-      .text(this.data.cluster_id);
+      .text(this.cluster.cluster.cluster_id);
     var status_col = $("<div/>")
       .addClass("status_col col-xs-3")
       .text("stopped");
@@ -134,9 +129,12 @@ define(["base/js/namespace", "jquery", "base/js/utils"], function (
       if (!/^\d+$/.test(n) && n.length > 0) {
         status_col.text("invalid engine #");
       } else {
+        if (n === "") {
+          n = null;
+        }
         var settings = {
           cache: false,
-          data: { n: n },
+          data: JSON.stringify({ n: n }),
           type: "POST",
           dataType: "json",
           success: function (data, status, xhr) {
@@ -151,7 +149,7 @@ define(["base/js/namespace", "jquery", "base/js/utils"], function (
         var url = utils.url_join_encode(
           that.base_url,
           "ipyparallel/clusters",
-          that.cluster_key
+          that.cluster.id
         );
         ajax(url, settings);
       }
@@ -163,25 +161,17 @@ define(["base/js/namespace", "jquery", "base/js/utils"], function (
 
     var profile_col = $("<div/>")
       .addClass("profile_col col-xs-2")
-      .text(this.data.cluster.profile);
+      .text(this.cluster.cluster.profile);
     var cluster_id_col = $("<div/>")
       .addClass("cluster_id_col col-xs-2")
-      .text(this.data.cluster.cluster_id);
+      .text(this.cluster.cluster.cluster_id);
     var status_col = $("<div/>")
       .addClass("status_col col-xs-3")
       .text("running");
 
-    // calculate n_engines
-    var n_engines = 0;
-    $.map(this.data.engines.sets, function (engine_set) {
-      if (engine_set.n) {
-        n_engines += engine_set.n;
-      }
-    });
-
     var engines_col = $("<div/>")
       .addClass("engines_col col-xs-3")
-      .text(n_engines);
+      .text(this.cluster.engines.n);
     var stop_button = $("<button/>")
       .addClass("btn btn-default btn-xs")
       .text("Stop");
@@ -204,7 +194,7 @@ define(["base/js/namespace", "jquery", "base/js/utils"], function (
         type: "DELETE",
         dataType: "json",
         success: function (data, status, xhr) {
-          that.update_state(data);
+          that.cluster_list.load_list();
         },
         error: function (xhr, status, error) {
           utils.log_ajax_error(xhr, status, error),
@@ -215,7 +205,7 @@ define(["base/js/namespace", "jquery", "base/js/utils"], function (
       var url = utils.url_join_encode(
         that.base_url,
         "ipyparallel/clusters",
-        that.cluster_key
+        that.cluster.id
       );
       ajax(url, settings);
     });

ipyparallel/util.py

@@ -683,7 +683,7 @@ def _all_profile_dirs():
     with os.scandir(get_ipython_dir()) as paths:
         for path in paths:
             if path.is_dir() and path.name.startswith('profile_'):
-                profile_dirs.append(path)
+                profile_dirs.append(path.path)
     return profile_dirs