Skip to content

erp5
erp5
Commit 6d9ac10a authored by Romain Courteaud's avatar Romain Courteaud
3 Browse files
Options

erp5_core: add Base_reindexAndSenseAlarm script 

Trigger activeSense on an alarm after an object is indexed.
The idea is to use this script in an interaction workflow to trigger the alarm.

If called multiple times, try to reduce the number of alarm execution.
parent f39555c5
Pipeline #35507 failed with stage
    in 0 seconds
    Expand all Hide whitespace changes
    Inline Side-by-side
    Showing with 658 additions and 0 deletions
    product/ERP5/bootstrap/erp5_core/SkinTemplateItem/portal_skins/erp5_core/Base_reindexAndSenseAlarm.py 0 → 100644
    View file @ 6d9ac10a
    from zExceptions import Unauthorized
    if REQUEST is not None:
    raise Unauthorized
    portal = context.getPortalObject()
    alarm_tool = portal.portal_alarms
    # Higher than simulable movement priority
    # priority=3, to be executed after all reindex, but also execute simulation _expand
    PRIORITY = 3
    if alarm_tool.isSubscribed() and len(alarm_id_list):
    # No alarm tool is not subscribed, respect this choice and do not activate any alarm
    tag = None
    if must_reindex_context:
    tag = "%s-%s" % (script.id, context.getRelativeUrl())
    context.reindexObject(activate_kw={'tag': tag})
    for alarm_id in alarm_id_list:
    alarm = alarm_tool.restrictedTraverse(alarm_id)
    deduplication_tag = 'Base_reindexAndSenseAlarm_%s' % alarm_id
    if alarm.isEnabled():
    # do nothing if the alarm is not enabled
    if tag is not None:
    activate_kw = {}
    activate_kw['activity'] = 'SQLQueue'
    activate_kw['after_tag'] = tag
    activate_kw['tag'] = deduplication_tag
    activate_kw['priority'] = max(1, PRIORITY-1)
    # Wait for the context indexation to be finished
    alarm_tool.activate(**activate_kw).Base_reindexAndSenseAlarm([alarm_id],
    must_reindex_context=False)
    elif portal.portal_activities.countMessageWithTag(deduplication_tag) <= 1:
    if alarm.isActive():
    # If the alarm is active, wait for it
    # and try to reduce the number of activities
    # to reduce the number of alarm execution
    activate_kw = {}
    activate_kw['activity'] = 'SQLQueue'
    activate_kw['priority'] = PRIORITY
    activate_kw['tag'] = deduplication_tag
    activate_kw['after_path'] = alarm.getPath()
    # Wait for the previous alarm run to be finished
    # call on alarm tool to gather and drop with sqldict
    alarm_tool.activate(**activate_kw).Base_reindexAndSenseAlarm([alarm_id],
    must_reindex_context=False)
    else:
    # activeSense create an activity in SQLDict
    alarm.activeSense()
    # Prevent 2 nodes to call activateSense concurrently
    alarm.serialize()
    product/ERP5/bootstrap/erp5_core/SkinTemplateItem/portal_skins/erp5_core/Base_reindexAndSenseAlarm.xml 0 → 100644
    View file @ 6d9ac10a
    <?xml version="1.0"?>
    <ZopeData>
    <record id="1" aka="AAAAAAAAAAE=">
    <pickle>
    <global name="PythonScript" module="Products.PythonScripts.PythonScript"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>_bind_names</string> </key>
    <value>
    <object>
    <klass>
    <global name="_reconstructor" module="copy_reg"/>
    </klass>
    <tuple>
    <global name="NameAssignments" module="Shared.DC.Scripts.Bindings"/>
    <global name="object" module="__builtin__"/>
    <none/>
    </tuple>
    <state>
    <dictionary>
    <item>
    <key> <string>_asgns</string> </key>
    <value>
    <dictionary>
    <item>
    <key> <string>name_container</string> </key>
    <value> <string>container</string> </value>
    </item>
    <item>
    <key> <string>name_context</string> </key>
    <value> <string>context</string> </value>
    </item>
    <item>
    <key> <string>name_m_self</string> </key>
    <value> <string>script</string> </value>
    </item>
    <item>
    <key> <string>name_subpath</string> </key>
    <value> <string>traverse_subpath</string> </value>
    </item>
    </dictionary>
    </value>
    </item>
    </dictionary>
    </state>
    </object>
    </value>
    </item>
    <item>
    <key> <string>_params</string> </key>
    <value> <string>alarm_id_list, must_reindex_context=True, REQUEST=None</string> </value>
    </item>
    <item>
    <key> <string>id</string> </key>
    <value> <string>Base_reindexAndSenseAlarm</string> </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    </ZopeData>
    product/ERP5/bootstrap/erp5_core/TestTemplateItem/portal_components/test.erp5.testERP5CoreSkins.xml 0 → 100644
    View file @ 6d9ac10a
    <?xml version="1.0"?>
    <ZopeData>
    <record id="1" aka="AAAAAAAAAAE=">
    <pickle>
    <global name="Test Component" module="erp5.portal_type"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>default_reference</string> </key>
    <value> <string>testERP5CoreSkins</string> </value>
    </item>
    <item>
    <key> <string>description</string> </key>
    <value>
    <none/>
    </value>
    </item>
    <item>
    <key> <string>id</string> </key>
    <value> <string>test.erp5.testERP5CoreSkins</string> </value>
    </item>
    <item>
    <key> <string>sid</string> </key>
    <value>
    <none/>
    </value>
    </item>
    <item>
    <key> <string>text_content_error_message</string> </key>
    <value>
    <tuple/>
    </value>
    </item>
    <item>
    <key> <string>text_content_warning_message</string> </key>
    <value>
    <tuple/>
    </value>
    </item>
    <item>
    <key> <string>version</string> </key>
    <value> <string>erp5</string> </value>
    </item>
    <item>
    <key> <string>workflow_history</string> </key>
    <value>
    <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
    </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    <record id="2" aka="AAAAAAAAAAI=">
    <pickle>
    <global name="PersistentMapping" module="Persistence.mapping"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>data</string> </key>
    <value>
    <dictionary>
    <item>
    <key> <string>component_validation_workflow</string> </key>
    <value>
    <persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
    </value>
    </item>
    </dictionary>
    </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    <record id="3" aka="AAAAAAAAAAM=">
    <pickle>
    <global name="WorkflowHistoryList" module="Products.ERP5Type.Workflow"/>
    </pickle>
    <pickle>
    <dictionary>
    <item>
    <key> <string>_log</string> </key>
    <value>
    <list>
    <dictionary>
    <item>
    <key> <string>action</string> </key>
    <value> <string>validate</string> </value>
    </item>
    <item>
    <key> <string>validation_state</string> </key>
    <value> <string>validated</string> </value>
    </item>
    </dictionary>
    </list>
    </value>
    </item>
    </dictionary>
    </pickle>
    </record>
    </ZopeData>
    product/ERP5/bootstrap/erp5_core/bt/template_test_id_list 0 → 100644
    View file @ 6d9ac10a
    test.erp5.testERP5CoreSkins
    \ No newline at end of file
    product/ERP5/bootstrap/erp5_core/bt/test_dependency_list 0 → 100644
    View file @ 6d9ac10a
    erp5_full_text_mroonga_catalog
    • Jérome Perrin @jerome ·
      Owner

      @romain was there a strong reason to add the test in erp5_core and not in erp5_core_test ? to keep erp5_core minimal ( see https://lab.nexedi.com/nexedi/erp5/-/blob/6d9ac10aa680c885f58759eb7038e2315ec7448e/product/ERP5/bootstrap/erp5_core/bt/comment#L3 ) the tests are in erp5_core_test

      The immediate problem seems to be https://erp5js.nexedi.net/#/test_result_module/20240627-5CD6DD6D/96 the diff is https://softinst145611.host.vifib.net/eci-Kn8PyTdC0a/CodingStyleTest-erp5_full_text_myisam_catalog/CodingStyleTest.CodingStyleTest%20erp5_full_text_myisam_catalog.test_rebuild_business_template.diff it seems that because of this dependency, when testing erp5_full_text_myisam_catalog, erp5_full_text_mroonga_catalog becomes installed.

      It seems better to ignore that we could just delete erp5_full_text_mroonga_catalog business template, each time erp5_core grows it's a (small) problem.

      BTW, according to the description of erp5_core, even this Base_reindexAndSenseAlarm should not be in erp5_core (but I don't know what's a better place, this script seems not used)

      Edited by Jérome Perrin
    • Jérome Perrin @jerome ·
      Owner

      ah I just understood the script, that's use case, that's useful. I wrote more or less the same script already.

      For the records, when I did that, I tried to use a short delay, also combining with at_date parameter of activate, to execute the alarm after x minutes, with the idea that if there are many similar user actions in a short time, the alarm is executed only once after user finished, the use case was to refresh an expensive cache for accounting after validating accounts or projects. In practice, I'm not sure this delay really worked, finding the right number for x minutes is impossible, so this is more a comment to explain that using at_date is not really good.

    • Romain Courteaud @romain ·
      Owner

      @romain was there a strong reason to add the test in erp5_core and not in erp5_core_test ?

      No reason at all. I completely forgot about erp5_core_test. I'll move the test.

      BTW, according to the description of erp5_core, even this Base_reindexAndSenseAlarm should not be in erp5_core (but I don't know what's a better place, this script seems not used)

      This script seems already used by 2 projects, including slapos master. I expect it to be used by other public bt5 some days. I know we should keep erp5_core minimal, but I didn't think of a better bt5 to put this script.

    Please register or sign in to reply
    erp5_simulation_test
    \ No newline at end of file
    Markdown is supported
    0% or
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment
    GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7