Patch #26439

Plugin load order defined by plugin checks

Added by Tiago Gonçalves about 5 years ago. Updated almost 4 years ago.

Status:NewStart date:
Priority:NormalDue date:
Assignee:-% Done:

0%

Category:Plugin API
Target version:-

Description

This patch allows for a plugin to delay loading until a set of requirements is met. This could be because I need for other plugin to be loaded first.

The ideia is to to have each plugin check at the top of init.rb for it's requirements and if they are not met to raise Redmine::Plugin::PluginDeferLoadError. This will signal the plugin load logic to try loading this plugin later.

The algorithm prevents infinite looping (by direct or indirect circular dependencies) by loading plugins by iterations. In each iteration amount of plugins to load must be lower.

The most common check made by plugins can be simplified by using at the top of the init.rb this line:

Redmine::Plugin.requires_plugin('redmine_plugin_name')

Regards

redmine_plugin_load.patch Magnifier (2.24 KB) Tiago Gonçalves, 2017-07-14 15:36

Related issues

Related to Redmine - Feature #23131: Plugin load order defined by inter-plugin dependencies Reopened

History

#1 Updated by Tiago Gonçalves about 5 years ago

Relates to:

#2 Updated by Go MAEDA about 5 years ago

  • Category set to Plugin API

#3 Updated by Go MAEDA about 5 years ago

  • Related to Feature #23131: Plugin load order defined by inter-plugin dependencies added

#4 Updated by Toshi MARUYAMA about 5 years ago

  • Description updated (diff)

#5 Updated by Vincent Robert almost 4 years ago

Hello Tiago
Is this patch compatible with Redmine 4?
I quickly tried it, but I got some errors.
Thank you

Also available in: Atom PDF