Merge pull request #2 from data-exp-lab/nb_culling

Nb culling

Author: Xarthisius

server/__init__.py

@@ -1,7 +1,9 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
-from girder import events
+import datetime
+
+from girder import events, logger
 from girder.models.model_base import ValidationException
 from girder.api import access
 from girder.api.describe import Description, describeRoute
@@ -10,22 +12,36 @@
 from .constants import PluginSettings
 
 from girder.utility.model_importer import ModelImporter
-from girder.utility import assetstore_utilities
+from girder.utility import assetstore_utilities, setting_utilities
 from girder.api.rest import getCurrentUser, getApiUrl
 
 
+_last_culling = datetime.datetime.utcnow()
+
+
 class Job(Resource):
 
     def __init__(self):
         super(Job, self).__init__()
 
 
-def validateSettings(event):
-    if event.info['key'] == PluginSettings.TMPNB_URL:
-        if not event.info['value']:
-            raise ValidationException(
-                'TmpNB URL must not be empty.', 'value')
-        event.preventDefault().stopPropagation()
+@setting_utilities.validator(PluginSettings.TMPNB_URL)
+def validateTmpNbUrl(doc):
+    if not doc['value']:
+        raise ValidationException(
+            'TmpNB URL must not be empty.', 'value')
+
+
+@setting_utilities.validator(PluginSettings.CULLING_PERIOD)
+def validateCullingPeriod(doc):
+    try:
+        float(doc['value'])
+    except KeyError:
+        raise ValidationException(
+            'Culling period must not be empty.', 'value')
+    except ValueError:
+        raise ValidationException(
+            'Culling period must float.', 'value')
 
 
 class ytHub(Resource):
@@ -158,9 +174,8 @@ def getNotebook(self, notebook, params):
         .errorResponse('Write access was denied for the notebook.', 403)
     )
     def deleteNotebook(self, notebook, params):
-        notebookModel = self.model('notebook', 'ythub')
-        notebookModel.deleteNotebook(notebook, self.getCurrentToken())
-        notebookModel.remove(notebook)
+        self.model('notebook', 'ythub').deleteNotebook(
+            notebook, self.getCurrentToken())
 
     @access.user
     @loadmodel(model='folder', level=AccessType.READ)
@@ -296,10 +311,20 @@ def folderRootpath(self, folder, params):
         folder, user=self.getCurrentUser())
 
 
+def cullNotebooks(event):
+    global _last_culling
+    logger.info('Got heartbeat in cullNotebooks')
+    culling_freq = datetime.timedelta(minutes=1)
+    if datetime.datetime.utcnow() - culling_freq > _last_culling:
+        logger.info('Performing culling')
+        ModelImporter.model('notebook', 'ythub').cullNotebooks()
+        _last_culling = datetime.datetime.utcnow()
+
+
 def load(info):
-    events.bind('model.setting.validate', 'ythub', validateSettings)
     events.bind('filesystem_assetstore_imported', 'ythub',
                 saveImportPathToMeta)
+    events.bind('heartbeat', 'ythub', cullNotebooks)
     info['apiRoot'].ythub = ytHub()
     info['apiRoot'].notebook = Notebook()
     info['apiRoot'].folder.route('GET', (':id', 'contents'),

server/constants.py

@@ -6,6 +6,7 @@
 
 
 class PluginSettings:
+    CULLING_PERIOD = 'ythub.culling_period'
     TMPNB_URL = 'ythub.tmpnb_url'
 
 

server/models/notebook.py

@@ -5,7 +5,9 @@
 import json
 import requests
 import six
+import dateutil.parser
 
+from girder import logger
 from ..constants import PluginSettings
 from girder.api.rest import RestException
 from girder.constants import AccessType, SortDir
@@ -74,6 +76,46 @@ def deleteNotebook(self, notebook, token):
         }
         requests.delete(self.model('setting').get(PluginSettings.TMPNB_URL),
                         json=payload)
+        # TODO: handle error
+        self.remove(notebook)
+
+    def cullNotebooks(self):
+        resp = requests.get(
+            self.model('setting').get(PluginSettings.TMPNB_URL))
+        content = resp.content
+        if isinstance(content, six.binary_type):
+            content = content.decode('utf8')
+        try:
+            resp.raise_for_status()
+        except requests.HTTPError:
+            raise RestException(
+                'Got %s code from tmpnb, response="%s"/' % (
+                    resp.status_code, content
+                ), code=502)
+        try:
+            activity = json.loads(content)
+        except ValueError:
+            raise RestException('Non-JSON response: %s' % content, code=502)
+
+        admin = next(_ for _ in self.model('user').getAdmins())
+        token = self.model('token').createToken(user=admin, days=1)
+
+        # Iterate over all notebooks, not the prettiest way...
+        cull_period = self.model('setting').get(
+            PluginSettings.CULLING_PERIOD, '4')
+        cull_time = datetime.datetime.utcnow() - \
+            datetime.timedelta(hours=float(cull_period))
+        for nb in self.find({}):
+            try:
+                last_activity = dateutil.parser.parse(
+                    activity[nb['containerId']], ignoretz=True)
+            except KeyError:
+                # proxy is not aware of such container, kill it...
+                logger.info('deleting nb %s' % nb['_id'])
+                self.deleteNotebook(nb, token)
+            if last_activity < cull_time:
+                logger.info('deleting nb %s' % nb['_id'])
+                self.deleteNotebook(nb, token)
 
     def createNotebook(self, folder, user, token, when=None, save=True):
         existing = self.findOne({

web_client/js/ConfigView.js

@@ -10,6 +10,9 @@ girder.views.ythub_ConfigView = girder.View.extend({
             this._saveSettings([{
                 key: 'ythub.tmpnb_url',
                 value: this.$('#ythub_tmpnb').val().trim()
+            }, {
+                key: 'ythub.culling_period',
+                value: this.$('#ythub_culling').val().trim()
             }]);
         }
     },
@@ -19,13 +22,14 @@ girder.views.ythub_ConfigView = girder.View.extend({
             path: 'system/setting',
             data: {
                 list: JSON.stringify([
-                    'ythub.tmpnb_url'
+                    'ythub.tmpnb_url',
+                    'ythub.culling_period'
                 ])
             }
         }).done(_.bind(function (resp) {
             this.render();
             this.$('#ythub_tmpnb').val(resp['ythub.tmpnb_url']);
-
+            this.$('#ythub_culling').val(resp['ythub.culling_period']);
         }, this));
     },
 

web_client/templates/ythub_config.jade

@@ -4,6 +4,9 @@ form#g-ythub-config-form(role="form")
     label.control-label(for="ythub_tmpnb") tmpnb URL
     input.input-sm.form-control#ythub_tmpnb(
       type="text", placeholder="Temporary notebook server's URL")
+    label.control-label(for="ythub_culling") Cull notebooks that are inactive for that many hours
+    input.input-sm.form-control#ythub_culling(
+      type="text", placeholder="Maximum inactivity period (hours) before notebook is deleted")
 
   p#g-ythub-error-message.g-validation-failed-message
   input.btn.btn-sm.btn-primary(type="submit", value="Save")