ks/celery

CHANGES.md

@@ -73,6 +73,7 @@ Changelog
 3.0.0b134 (2024-06-06)
 ----------------------
 
+- update celery control panel
 - Fix mass copy/paste functionality
 - Handle additional edge case errors when reindexing
 

README.rst

@@ -88,11 +88,11 @@ Development setup on macOS
 1. ``brew install redis elasticsearch libav python``
 2. ``git clone git@github.com:castlecms/castle.cms.git``
 3. ``cd castle.cms``
-4. ``virtualenv -p python2.7 .``
-5. ``bin/pip install --upgrade pip``
-6. ``bin/pip install -r requirements.txt``
-7. ``bin/buildout``
-8. Run (in separate terminal windows) ``elasticsearch``, ``redis-server``, ``bin/instance fg``
+4. ``virtualenv -p python2.7 env``
+5. ``env/bin/pip install --upgrade pip``
+6. ``env/bin/pip install -r requirements.txt``
+7. ``env/bin/buildout``
+8. Run (in separate terminal windows) ``redis-server``, ``env/bin/instance fg``
 9. Browse to http://localhost:8080/
 
 Once you have created a site in the development instance:
@@ -102,6 +102,13 @@ Once you have created a site in the development instance:
 12. See the /docs/ folder for further development information
 
 
+Development -- Tasks Control Panel (Celery)
+-------------------------------------------
+Make sure that CELERY_ALWAYS_EAGER is set to False. If set to True, tasks will be immediately handled and therefore not displayed on the task control panel.
+If you are not already running an instance of redis, start one in a new terminal with `redis-server`
+In a new terminal, start an instance of celery with `bin/pcelery worker parts/instance/etc/zope.conf -c 1 -E`
+In your browser, navigate to the control panel on your Castle site and view the Tasks page
+
 Optional Dependencies
 ---------------------
 
@@ -120,7 +127,7 @@ Running tests
 
 .. code-block:: shell
 
-  ./bin/test -s castle.cms
+  ./bin/test -pvc -s castle.cms -m test_content
 
 
 *To run only robot tests:*
@@ -147,7 +154,6 @@ Running local dependencies with docker
 
     or, just the essentials:
     $ docker run -p 6379:6379 redis
-    $ docker run -p 9200:9200 elasticsearch:2.4-alpine
 
 
 Forks/Custom releases

castle/cms/browser/controlpanel/ccelery.py

@@ -11,24 +11,84 @@ def info(self):
         try:
             ping = ins.ping()
         except Exception:
-            ping = ''
+            ping = None
         try:
             active = ins.active()
+            if active is None:
+                active = {}
         except Exception:
-            active = ''
+            active = {}
+        try:
+            scheduled = ins.scheduled()
+            if scheduled is None:
+                scheduled = {}
+        except Exception:
+            scheduled = {}
         try:
             reserved = ins.reserved()
+            if reserved is None:
+                reserved = {}
         except Exception:
-            reserved = ''
+            reserved = {}
         try:
             stats = ins.stats()
+            if stats is None:
+                stats = {}
         except Exception:
-            stats = ''
+            stats = {}
+        try:
+            registered = ins.registered()
+            if registered is None:
+                registered = {}
+        except Exception:
+            registered = {}
+        try:
+            report = ins.report()
+            if report is None:
+                report = {}
+            for worker in report.keys():
+                clean_info = report[worker]['ok'].replace('\'', '').replace('\"', '').replace(' \n', '').replace('\n ', '')
+                while True:
+                    alpha = len(clean_info)
+                    clean_info = clean_info.replace('  ', ' ')
+                    beta = len(clean_info)
+                    if alpha>beta:
+                        pass
+                    else:
+                        break
+                clean_info = clean_info.split('\n')
+                while True:
+                    try:
+                        index = clean_info.index('')
+                        clean_info.pop(index)
+                    except:
+                        report[worker] = clean_info
+                        break
+        except Exception as e:
+            report = {}
+        types = [[registered, "registered"], [reserved, "reserved"], [active, "active"], [scheduled, "scheduled"]]
+        counts = {}
+        for _type in types:
+            count = 0
+            keys = _type[0].keys()
+            try:
+                for key in keys:
+                    if _type[1] == "stats":
+                        count += len(_type[0][key].get('total'))
+                    else:
+                        count += len(_type[0][key])
+                counts[_type[1]]=count
+            except Exception:
+                counts[_type[1]]=0
         return {
             'workers': ping,
             'active': active,
+            'scheduled': scheduled,
             'reserved': reserved,
-            'stats': stats
+            'stats': stats,
+            'registered': registered,
+            'counts': counts,
+            'report': report,
         }
 
     def get_task_name(self, _id):

castle/cms/browser/controlpanel/templates/celery.pt

@@ -11,13 +11,12 @@
 
 <metal:main metal:fill-slot="prefs_configlet_main" i18n:domain="plone">
 
-    <a
-      href="${context/portal_url}/@@overview-controlpanel"
-      id="setup-link"
-    >
-      Site Setup
+    <a href=""
+       id="setup-link"
+       tal:attributes="href string:$portal_url/@@overview-controlpanel"
+       i18n:translate="">
+       Site Setup
     </a>
-
     <h1 class="documentFirstHeading"
         i18n:translate="">Celery Tasks</h1>
 

castle/cms/browser/controlpanel/templates/celery_task_info.pt

@@ -0,0 +1,23 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
+      xmlns:tal="http://xml.zope.org/namespaces/tal"
+      xmlns:metal="http://xml.zope.org/namespaces/metal"
+      xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+      lang="en"
+      metal:use-macro="context/prefs_main_template/macros/master"
+      i18n:domain="plone">
+  <body>
+    <metal:main metal:fill-slot="prefs_configlet_main" i18n:domain="plone">
+      <a href=""
+        id="setup-link"
+        tal:attributes="href string:$portal_url/@@overview-controlpanel"
+        i18n:translate="">
+        Site Setup
+      </a>
+      <h1 class="documentFirstHeading" i18n:translate="">Celery Tasks</h1>
+      <div class="documentDescription">
+        Inspect currently active celery tasks
+      </div>
+      <br />
+      </metal:main>
+    </body>
+</html>

castle/cms/browser/controlpanel/templates/celery_worker.pt

@@ -0,0 +1,19 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
+      xmlns:tal="http://xml.zope.org/namespaces/tal"
+      xmlns:metal="http://xml.zope.org/namespaces/metal"
+      xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+      lang="en"
+      metal:use-macro="context/prefs_main_template/macros/master"
+      i18n:domain="plone">
+
+    <body>
+        <metal:main metal:fill-slot="prefs_configlet_main" i18n:domain="plone">
+            <a href=""
+                id="tasks-link"
+                tal:attributes="href string:$portal_url/@@inspect-tasks"
+                i18n:translate="">
+                Inspect Tasks
+            </a>
+        </metal:main>
+    </body>
+</html>

castle/cms/static/plone-compiled.js

@@ -5405,11 +5405,13 @@ define('mockup-i18n',[
 
   var I18N = function() {
     var self = this;
-    self.baseUrl = $('body').attr('data-i18ncatalogurl');
+
+    self['baseUrl'] = $('body').attr('data-i18ncatalogurl');
 
     if (!self.baseUrl) {
       self.baseUrl = '/plonejsi18n';
     }
+
     self.currentLanguage = $('html').attr('lang') || 'en-us';
     self.storage = null;
     self.catalogs = {};
@@ -30165,5 +30167,5 @@ $(document).ready(function(){
 
 });
 
-define("/Users/brian.duncan/castle-instances/pages-to-folders/castle/cms/static/plone.js", function(){});
+define("/Users/katiewiessfelt/dev/git/castle/fbigov-dev/src/castle.cms/castle/cms/static/plone.js", function(){});
 

docker-compose.yml

@@ -5,25 +5,6 @@ services:
         image: "redis:alpine"
         ports:
             - 6379:6379
-    elasticsearch:
-        image: "elasticsearch:7.6.0"
-        ports:
-          - 9200:9200
-        environment:
-          - node.name=es01
-          - discovery.type=single-node
-        networks:
-          - elastic
-    kibana:
-        image: "docker.elastic.co/kibana/kibana:7.6.0"
-        container_name: "kibana"
-        ports:
-          - 5601:5601
-        environment:
-          ELASTICSEARCH_URL: http://elasticsearch:9200
-          ELASTICSEARCH_HOSTS: http://elasticsearch:9200
-        networks:
-          - elastic
     etherpad:
         image: "etherpad/etherpad"
         ports:
@@ -33,6 +14,3 @@ services:
         ports:
           - 1025:1025
           - 8025:8025
-networks:
-  elastic:
-    driver: bridge

requirements.txt

@@ -1,3 +1,4 @@
 cryptography==3.3.2
 setuptools==44.0.0
 zc.buildout==2.13.7
+Pillow==6.2.2

travis.cfg

@@ -32,7 +32,7 @@ develop = .
 
 eggs +=
     castle.cms[test]
-    celery[sqlalchemy]
+    celery[redis]
     collective.celery
     argon2_cffi
     Pillow
@@ -45,16 +45,16 @@ zcml =
 versions = versions
 
 [test-environment]
-CELERY_TASK_ALWAYS_EAGER = True
+CELERY_TASK_ALWAYS_EAGER = False
 
 [test]
 environment = test-environment
 
 [instance]
 eggs += plone.reload
 environment-vars =
-    BROKER_URL sqla+sqlite:///${buildout:directory}/celerydb.sqlite?timeout=30
-    CELERY_TASK_ALWAYS_EAGER True
+    BROKER_URL redis://127.0.0.1:6379/0
+    CELERY_TASK_ALWAYS_EAGER False
     REDIS_SERVER 127.0.0.1:6379
     LINK_REPORT_DB sqlite:///${buildout:directory}/linkreport.sqlite?timeout=30