Not possible to exclude the flowable-event-registry JAR even if EventRegistry disabled

[karel-cernohorsky]

Describe the bug

Even when disabling the EventRegistry via:

flowable.eventregistry.enabled = false

(see @ConditionalOnEventRegistry and its usage)

and / or via:

@Bean
EngineConfigurationConfigurer<SpringProcessEngineConfiguration> customConfig() {
    return spec -> spec.setDisableEventRegistry(true);
}

it's still not possible to exclude from dependencies the following JAR:

• flowable-event-registry

due to a missing check of whether the EventRegistry is disabled in:

flowable-engine/modules/flowable-engine/src/main/java/org/flowable/engine/impl/cfg/ProcessEngineConfigurationImpl.java

Line 1683 in 90b4b50

public void afterInitEventRegistryEventBusConsumer() {

thus not bypassing the instantiation of:

flowable-engine/modules/flowable-engine/src/main/java/org/flowable/engine/impl/cfg/ProcessEngineConfigurationImpl.java

Line 1688 in 90b4b50

bpmnEventRegistryEventConsumer = new BpmnEventRegistryEventConsumer(this);

Expected behavior

When the "EventRegistry" is "disabled" (via a property or a java code)
Then it's possible to exclude from dependencies the "flowable-event-registry" JAR 

Most likely via bypassing the instantiation of the BpmnEventRegistryEventConsumer in such a case.

Code

Currently, we are forced to apply a dummy work-around, such as:

@Bean
EngineConfigurationConfigurer<SpringProcessEngineConfiguration> customConfig() {
    return spec -> spec.setDisableEventRegistry(true)
            .setEventRegistryEventConsumer(noopEventRegistryEventConsumer());
}

private static EventRegistryEventConsumer noopEventRegistryEventConsumer() {
    return new EventRegistryEventConsumer() {
        @Override
        public EventRegistryProcessingInfo eventReceived(EventRegistryEvent event) {
            return null;
        }

        @Override
        public String getConsumerKey() {
            return "noopEventConsumer";
        }
    };
}

thus bypassing the instantiation of the BpmnEventRegistryEventConsumer in:

flowable-engine/modules/flowable-engine/src/main/java/org/flowable/engine/impl/cfg/ProcessEngineConfigurationImpl.java

Lines 1683 to 1692 in 90b4b50

	public void afterInitEventRegistryEventBusConsumer() {
	EventRegistryEventConsumer bpmnEventRegistryEventConsumer = null;
	if (eventRegistryEventConsumer != null) {
	bpmnEventRegistryEventConsumer = eventRegistryEventConsumer;
	} else {
	bpmnEventRegistryEventConsumer = new BpmnEventRegistryEventConsumer(this);
	}
	addEventRegistryEventConsumer(bpmnEventRegistryEventConsumer.getConsumerKey(), bpmnEventRegistryEventConsumer);
	}

For comparison, the IDM engine's inclusion is properly checked in:

flowable-engine/modules/flowable-engine/src/main/java/org/flowable/engine/impl/cfg/ProcessEngineConfigurationImpl.java

Lines 1676 to 1681 in 90b4b50

	public void afterInitTaskServiceConfiguration() {
	if (engineConfigurations.containsKey(EngineConfigurationConstants.KEY_IDM_ENGINE_CONFIG)) {
	IdmEngineConfigurationApi idmEngineConfiguration = (IdmEngineConfigurationApi) engineConfigurations.get(EngineConfigurationConstants.KEY_IDM_ENGINE_CONFIG);
	this.taskServiceConfiguration.setIdmIdentityService(idmEngineConfiguration.getIdmIdentityService());
	}
	}

Additional context

Flowable branches:

• flowable-release-7.0.0 (tested v. 7.0.1)
• flowable-release-7.1.0
• main

Spring Boot used in the version declared by the respective Flowable version.

relevant exclusions & dependencies in build.gradle:

configurations.all {
    excludeRules += [
        [ group: 'org.flowable', module: 'flowable-cmmn-model' ],
        [ group: 'org.flowable', module: 'flowable-dmn-model' ],
        [ group: 'org.flowable', module: 'flowable-event-registry' ],
        [ group: 'org.flowable', module: 'flowable-event-registry-configurator' ],
        [ group: 'org.flowable', module: 'flowable-event-registry-model' ],
        [ group: 'org.flowable', module: 'flowable-idm-engine' ],
        [ group: 'org.flowable', module: 'flowable-idm-engine-configurator' ],
        [ group: 'org.yaml', module: 'snakeyaml' ],
    ]
}

dependencies {
    implementation (
        [ group: 'org.flowable', name: 'flowable-http' ],
        [ group: 'org.flowable', name: 'flowable-secure-javascript' ],
        [ group: 'org.flowable', name: 'flowable-spring-boot-starter-process',
            exclude: [ group: 'org.flowable', module: 'flowable-event-registry-spring-configurator' ] ],
    )
}