OSGi does not always init properly when adding Workflow Actionlets

[wezell]

Parent Issue

No response

Problem Statement

When dotCMS is running with a plugin that provides a workflow action, and dotCMS gets restarted, there is a race condition between OSGi initing and the plugin trying to register the actionlet. If OSGI is fully initied, the actionlet will register. If not, the actionlet will not show up and the plugin needs to be manually re-added to be able to use the actionlet.

Steps to Reproduce

Its hard to reproduce because does not happen all the time.

1. Basically, add a plugin that provides an actionlet
2. Add the actionlet to a workflow action with some config
3. Make sure it works
4. restart dotCMS
5. try the action again.

It especially happens if your felix-cache is persisted across restarts.

Acceptance Criteria

make this not happen

dotCMS Version

24.09

Proposed Objective

Quality Assurance

Proposed Priority

Priority 2 - Important

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

[dsilvam]

Failed IQA: Still requires a redeployment of the plugin that includes actionlets for them to get installed/added.

First time:

dotcms-1      | 21:13:43.929  WARN  rules.RulesAPIImpl - Actionlet with name 'CountRulesActionlet' already registered.
dotcms-1      | 21:13:43.930  WARN  rules.RulesAPIImpl - Actionlet with name 'SetSessionAttributeActionlet' already registered.
dotcms-1      | 21:13:43.930  WARN  rules.RulesAPIImpl - Actionlet with name 'SetRequestAttributeActionlet' already registered.
dotcms-1      | 21:13:43.930  WARN  rules.RulesAPIImpl - Actionlet with name 'SetResponseHeaderActionlet' already registered.
dotcms-1      | 21:13:43.930  WARN  rules.RulesAPIImpl - Actionlet with name 'PersonaActionlet' already registered.
dotcms-1      | 21:13:43.930  WARN  rules.RulesAPIImpl - Actionlet with name 'VisitorTagsActionlet' already registered.
dotcms-1      | 21:13:43.930  WARN  rules.RulesAPIImpl - Actionlet with name 'SendRedirectActionlet' already registered.
dotcms-1      | 21:13:43.930  WARN  rules.RulesAPIImpl - Actionlet with name 'StopProcessingActionlet' already registered.
db-1          | 2024-10-22 21:13:52.246 UTC [45] ERROR:  duplicate key value violates unique constraint "shedlock_pkey"
db-1          | 2024-10-22 21:13:52.246 UTC [45] DETAIL:  Key (name)=(osgi_restart_lock) already exists.
db-1          | 2024-10-22 21:13:52.246 UTC [45] STATEMENT:  INSERT INTO shedlock(name, lock_until, locked_at, locked_by) VALUES($1, $2, $3, $4)
dotcms-1      | 21:13:52.251  INFO  framework.OSGIUtil - Starting the osgi reload on folder: /data/shared/felix/upload
dotcms-1      | 21:13:52.251  INFO  framework.OSGIUtil - OSGI - pathname: vision-0.4.1.jar

After reapplying the plugin:

dotcms-1      | Installing bundle com.dotcms.ai.vision / 0.4.1
dotcms-1      | 21:28:41.696  INFO  vision.Activator - Added actionlet: Open AI - Tag Images
dotcms-1      | 21:28:41.700  INFO  vision.Activator - Added actionlet: Open AI - Translate Content
dotcms-1      | Started bundle: file:/data/shared/felix/load/vision-0.4.1.jar

[wezell]

Was this in a cluster and you hit the "reinit plugins"? If so, I think that it is another issue and not the original one.

[github-actions]

PRs:

• #30291: waiting on OSGI to be initiated correctly before registering any workflow actionlets #30531
• #30291: Taking new approach with Java Future to avoid race condition #30632
• #30291: Reverting OSGI changes #30648

[dsilvam]

Failed IQA: Still not loading actionlets consistently when the plugin is installed.

[wezell]

I think we are battling two issues. The original PR fixed the issue of an actionlet loading locally. The second issue is with the use of shedlock to reinit osgi in a cluster that prevents multiple nodes from reloading osgi correctly.

We should not be using shedlock here I don't think. I would be interested in the original reasoning for doing so.

[dsilvam]

Passed IQA:

Two starts of the plugin both correctly installing the actionlets:

1      | 22:14:33.440  INFO  servlet.ServletToolboxManager - Trying config file '/WEB-INF/toolbox.xml'
dotcms-1      | 22:14:33.582  INFO  servlet.ServletToolboxManager - Toolbox setup complete.
dotcms-1      | 22:14:33.587  INFO  vision.Activator - Added actionlet: [Open AI - Tag Images]
dotcms-1      | 22:14:33.592  INFO  vision.Activator - Added actionlet: [Open AI - Translate Content]
dotcms-1      | Started bundle: file:/data/shared/felix/load/vision-0.4.1.jar
dotcms-1      | 22:14:44.057  INFO  osgi.OSGIResource - Portlets Removed: []
dotcms-1      | 22:14:44.057  INFO  osgi.OSGIResource - Actionlets Removed: []
dotcms-1      | 22:14:54.146  INFO  vision.Activator - Added actionlet: [Open AI - Tag Images]
dotcms-1      | 22:14:54.149  INFO  vision.Activator - Added actionlet: [Open AI - Translate Content]

[josemejias11]

Approved: Tested on trunk_3d77285, Docker, macOS 14.5, FF v126.0.1