Skip to content

Remove Joda Time support #4127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove Joda Time support #4127

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions distro/src/readme.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,30 @@ <h1>Links</h1>

<h1>Flowable Release Notes</h1>

<h3>Release Notes - Flowable - 8.0.0</h3>

<ul>
<li>
Remove Joda Time support.
If Joda Time variables were being used, then the Joda LocalDate variable is now an instance of java.time.LocalDate
and the Joda DateTime variable is now an instance of java.time.Instant.
If variables should keep being read as Joda Time (e.g., for custom scripts etc.), then with Spring Boot the property <code>flowable.joda-time-variable-support</code>
can be set to <code>WRITE</code>.
The available values for <code>flowable.joda-time-variable-support</code> are:
<ul>
<li><code>DISABLE</code> - Completely disables Joda Time. If you have Joda Time variables in the database then reading those variables will fail.
</li>
<li><code>READ_AS_JAVA_TIME</code> - Reads Joda Time variables from the database as Joda LocalDate and DateTime. This is the default configuration.
Copy link
Contributor

@martin-grofcik martin-grofcik Sep 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use case:
Completed process/case instance stores joda time variable.

Question:
Do we need to support at least read (if we reopen the case + write) for the time till the instance is not deleted from the history?

Copy link
Contributor Author

@filiphr filiphr Sep 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, but I am not quite following what you are asking @martin-grofcik. They would be read as Java Time when the READ_AS_JAVA_TIME is used. That's the idea at least. Why would you need to read and not write as Joda Time variables?

From a custom code perspective, you'll need to adjust to Java Time. From a Flowable point of view, Joda time variables won't be supported. Old variables would still work as they would be read as Java time.

Copy link
Contributor Author

@filiphr filiphr Sep 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep in mind that this is still work in progress, we have not made a final decision for how it should look like.

Copy link
Contributor

@martin-grofcik martin-grofcik Sep 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"work in progress" - yes that's why I am asking.

My understanding of the implementation for currently running instance with joda time variables:
READ_AS_JAVA_TIME - read joda time variable..... I do not take care of writing (done with Java Time).

It means if I have joda time variable in a case/process history, I have to use JodaDateTimeFallbackType to be able to read the variable.

Copy link
Contributor Author

@filiphr filiphr Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that I might understand the confusion. The description should say

Reads Joda Time variables from the database as Java LocalDate and Instant.

i.e. the variables would be read as Java Time objects, not as Joda objects. I'll update the description. Does that make more sense @martin-grofcik?

</li>
<li><code>WRITE</code> - Reads and Writes Joda Time variables. This is the same as prior to Flowable 8. The joda-time dependency has to be available
on the classpath.
</li>
</ul>
Keep in mind that this only works for variables, Flowable itself no longer supports Joda Time, i.e., due dates, timers, etc. no longer support Joda Time
values.
</li>
</ul>

<h3>Release Notes - Flowable - 7.2.0</h3>

<ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/docusaurus/docs/cmmn/ch06-cmmn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -929,7 +929,7 @@ Properties:

- **Timer expression**: an expression that defines when the timer should occur. The following options are possible:

- An expression resolving to a java.util.Date or org.joda.time.DateTime instance (for example, \_${someBean.calculateNextDate(someCaseInstanceVariable)})
- An expression resolving to a java.util.Date, java.time.Instant, java.time.LocalDate or java.time.LocalDateTime instance (for example, \_${someBean.calculateNextDate(someCaseInstanceVariable)})

- An ISO8601 date

Expand Down
17 changes: 3 additions & 14 deletions ...e-app-engine-rest/src/test/java/org/flowable/app/rest/service/BaseSpringRestTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,20 @@
package org.flowable.app.rest.service;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.fail;

import java.io.IOException;
import java.io.UncheckedIOException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.TimeZone;

import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
Expand All @@ -50,8 +49,6 @@
import org.flowable.common.engine.impl.test.EnsureCleanDb;
import org.flowable.common.engine.impl.test.LoggingExtension;
import org.flowable.common.rest.util.RestUrlBuilder;
import org.joda.time.format.DateTimeFormatter;
import org.joda.time.format.ISODateTimeFormat;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.extension.ExtendWith;
Expand Down Expand Up @@ -271,19 +268,11 @@ protected void assertErrorResult(String url, ObjectNode body, int statusCode) th
* Extract a date from the given string. Assertion fails when invalid date has been provided.
*/
protected Date getDateFromISOString(String isoString) {
DateTimeFormatter dateFormat = ISODateTimeFormat.dateTime();
try {
return dateFormat.parseDateTime(isoString).toDate();
} catch (IllegalArgumentException iae) {
fail("Illegal date provided: " + isoString);
return null;
}
return Date.from(Instant.parse(isoString));
}

protected String getISODateString(Date time) {
TimeZone tz = TimeZone.getTimeZone("UTC");
longDateFormat.setTimeZone(tz);
return longDateFormat.format(time);
return time.toInstant().toString();
}

protected String buildUrl(String[] fragments, Object... arguments) {
Expand Down
22 changes: 18 additions & 4 deletions ...les/flowable-app-engine/src/main/java/org/flowable/app/engine/AppEngineConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
import org.flowable.common.engine.impl.el.ExpressionManager;
import org.flowable.common.engine.impl.interceptor.CommandInterceptor;
import org.flowable.common.engine.impl.interceptor.EngineConfigurationConstants;
import org.flowable.common.engine.impl.joda.JodaDeprecationLogger;
import org.flowable.common.engine.impl.persistence.deploy.DefaultDeploymentCache;
import org.flowable.common.engine.impl.persistence.deploy.DeploymentCache;
import org.flowable.common.engine.impl.persistence.entity.TableDataManager;
Expand All @@ -80,6 +81,7 @@
import org.flowable.variable.api.types.VariableType;
import org.flowable.variable.api.types.VariableTypes;
import org.flowable.variable.service.VariableServiceConfiguration;
import org.flowable.variable.service.impl.JodaTimeVariableSupport;
import org.flowable.variable.service.impl.db.IbatisVariableTypeHandler;
import org.flowable.variable.service.impl.types.BigDecimalType;
import org.flowable.variable.service.impl.types.BigIntegerType;
Expand All @@ -91,8 +93,6 @@
import org.flowable.variable.service.impl.types.EmptyCollectionType;
import org.flowable.variable.service.impl.types.InstantType;
import org.flowable.variable.service.impl.types.IntegerType;
import org.flowable.variable.service.impl.types.JodaDateTimeType;
import org.flowable.variable.service.impl.types.JodaDateType;
import org.flowable.variable.service.impl.types.JsonType;
import org.flowable.variable.service.impl.types.LocalDateTimeType;
import org.flowable.variable.service.impl.types.LocalDateType;
Expand Down Expand Up @@ -156,6 +156,8 @@ public class AppEngineConfiguration extends AbstractBuildableEngineConfiguration
*/
protected boolean jsonVariableTypeTrackObjects = true;

protected JodaTimeVariableSupport jodaTimeVariableSupport = JodaTimeVariableSupport.READ_AS_JAVA_TIME;


protected BusinessCalendarManager businessCalendarManager;

Expand Down Expand Up @@ -402,8 +404,7 @@ public void initVariableTypes() {
variableTypes.addType(new InstantType());
variableTypes.addType(new LocalDateType());
variableTypes.addType(new LocalDateTimeType());
variableTypes.addType(new JodaDateType());
variableTypes.addType(new JodaDateTimeType());
jodaTimeVariableSupport.registerJodaTypes(variableTypes);
variableTypes.addType(new DoubleType());
variableTypes.addType(new BigDecimalType());
variableTypes.addType(new BigIntegerType());
Expand Down Expand Up @@ -740,6 +741,19 @@ public AppEngineConfiguration setJsonVariableTypeTrackObjects(boolean jsonVariab
return this;
}

public JodaTimeVariableSupport getJodaTimeVariableSupport() {
return jodaTimeVariableSupport;
}

public AppEngineConfiguration setJodaTimeVariableSupport(JodaTimeVariableSupport jodaTimeVariableSupport) {
//noinspection deprecation
if (JodaTimeVariableSupport.WRITE == jodaTimeVariableSupport) {
JodaDeprecationLogger.LOGGER.warn("Using deprecated joda time write support for the app engine configuration");
}
this.jodaTimeVariableSupport = jodaTimeVariableSupport;
return this;
}

public boolean isDisableIdmEngine() {
return disableIdmEngine;
}
Expand Down
4 changes: 0 additions & 4 deletions modules/flowable-batch-service/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,6 @@
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
</dependency>
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
Expand Down
4 changes: 0 additions & 4 deletions modules/flowable-bpmn-converter/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,6 @@
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
</dependency>
<dependency>
<groupId>joda-time</groupId>
<artifactId>joda-time</artifactId>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-reload4j</artifactId>
Expand Down
22 changes: 18 additions & 4 deletions .../flowable-cmmn-engine/src/main/java/org/flowable/cmmn/engine/CmmnEngineConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,7 @@
import org.flowable.common.engine.impl.interceptor.CommandInterceptor;
import org.flowable.common.engine.impl.interceptor.EngineConfigurationConstants;
import org.flowable.common.engine.impl.javax.el.ELResolver;
import org.flowable.common.engine.impl.joda.JodaDeprecationLogger;
import org.flowable.common.engine.impl.persistence.deploy.DefaultDeploymentCache;
import org.flowable.common.engine.impl.persistence.deploy.DeploymentCache;
import org.flowable.common.engine.impl.persistence.entity.TableDataManager;
Expand Down Expand Up @@ -304,6 +305,7 @@
import org.flowable.variable.api.types.VariableTypes;
import org.flowable.variable.service.VariableServiceConfiguration;
import org.flowable.variable.service.history.InternalHistoryVariableManager;
import org.flowable.variable.service.impl.JodaTimeVariableSupport;
import org.flowable.variable.service.impl.db.IbatisVariableTypeHandler;
import org.flowable.variable.service.impl.types.BigDecimalType;
import org.flowable.variable.service.impl.types.BigIntegerType;
Expand All @@ -315,8 +317,6 @@
import org.flowable.variable.service.impl.types.EmptyCollectionType;
import org.flowable.variable.service.impl.types.InstantType;
import org.flowable.variable.service.impl.types.IntegerType;
import org.flowable.variable.service.impl.types.JodaDateTimeType;
import org.flowable.variable.service.impl.types.JodaDateType;
import org.flowable.variable.service.impl.types.JsonType;
import org.flowable.variable.service.impl.types.LocalDateTimeType;
import org.flowable.variable.service.impl.types.LocalDateType;
Expand Down Expand Up @@ -514,6 +514,8 @@ public class CmmnEngineConfiguration extends AbstractBuildableEngineConfiguratio
*/
protected boolean jsonVariableTypeTrackObjects = true;

protected JodaTimeVariableSupport jodaTimeVariableSupport = JodaTimeVariableSupport.READ_AS_JAVA_TIME;

protected List<CaseInstanceMigrationCallback> caseInstanceMigrationCallbacks;

// Set Http Client config defaults
Expand Down Expand Up @@ -1408,8 +1410,7 @@ public void initVariableTypes() {
variableTypes.addType(new InstantType());
variableTypes.addType(new LocalDateType());
variableTypes.addType(new LocalDateTimeType());
variableTypes.addType(new JodaDateType());
variableTypes.addType(new JodaDateTimeType());
jodaTimeVariableSupport.registerJodaTypes(variableTypes);
variableTypes.addType(new DoubleType());
variableTypes.addType(new BigDecimalType());
variableTypes.addType(new BigIntegerType());
Expand Down Expand Up @@ -2967,6 +2968,19 @@ public CmmnEngineConfiguration setJsonVariableTypeTrackObjects(boolean jsonVaria
return this;
}

public JodaTimeVariableSupport getJodaTimeVariableSupport() {
return jodaTimeVariableSupport;
}

public CmmnEngineConfiguration setJodaTimeVariableSupport(JodaTimeVariableSupport jodaTimeVariableSupport) {
//noinspection deprecation
if (JodaTimeVariableSupport.WRITE == jodaTimeVariableSupport) {
JodaDeprecationLogger.LOGGER.warn("Using deprecated joda time write support for the CMMN engine configuration");
}
this.jodaTimeVariableSupport = jodaTimeVariableSupport;
return this;
}

public CaseDiagramGenerator getCaseDiagramGenerator() {
return caseDiagramGenerator;
}
Expand Down
10 changes: 1 addition & 9 deletions ...java/org/flowable/cmmn/engine/impl/behavior/impl/TimerEventListenerActivityBehaviour.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,12 @@
import org.flowable.common.engine.impl.calendar.DueDateBusinessCalendar;
import org.flowable.common.engine.impl.el.ExpressionManager;
import org.flowable.common.engine.impl.interceptor.CommandContext;
import org.flowable.common.engine.impl.joda.JodaDeprecationLogger;
import org.flowable.common.engine.impl.runtime.Clock;
import org.flowable.common.engine.impl.util.DateUtil;
import org.flowable.job.service.JobServiceConfiguration;
import org.flowable.job.service.impl.persistence.entity.JobEntity;
import org.flowable.job.service.impl.persistence.entity.TimerJobEntity;
import org.flowable.job.service.impl.persistence.entity.TimerJobEntityManager;
import org.joda.time.DateTime;

/**
* {@link CmmnActivityBehavior} implementation for the CMMN Timer Event Listener.
Expand Down Expand Up @@ -101,12 +99,6 @@ protected void handleCreateTransition(CommandContext commandContext, PlanItemIns
if (timerValue instanceof Date) {
timerDueDate = (Date) timerValue;

} else if (timerValue instanceof DateTime timerDateTime) {
JodaDeprecationLogger.LOGGER.warn(
"Using Joda-Time DateTime has been deprecated and will be removed in a future version. Timer event listener expression {} in {} resolved to a Joda-Time DateTime. ",
timerEventListener.getTimerExpression(), planItemInstance);
timerDueDate = timerDateTime.toDate();

} else if (timerValue instanceof String timerString) {

BusinessCalendarManager businessCalendarManager = CommandContextUtil.getCmmnEngineConfiguration(commandContext).getBusinessCalendarManager();
Expand Down Expand Up @@ -146,7 +138,7 @@ protected void handleCreateTransition(CommandContext commandContext, PlanItemIns
}

if (timerDueDate == null) {
throw new FlowableException("Timer expression '" + timerEventListener.getTimerExpression() + "' did not resolve to java.util.Date, org.joda.time.DateTime, "
throw new FlowableException("Timer expression '" + timerEventListener.getTimerExpression() + "' did not resolve to java.util.Date, "
+ "java.time.Instant, java.time.LocalDate, java.time.LocalDateTime or "
+ "an ISO8601 date/duration/repetition string or a cron expression for " + planItemInstance);
}
Expand Down
8 changes: 7 additions & 1 deletion ...engine/src/main/java/org/flowable/cmmn/engine/impl/cmd/DeleteHistoricCaseInstanceCmd.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import org.flowable.cmmn.api.history.HistoricCaseInstance;
import org.flowable.cmmn.engine.CmmnEngineConfiguration;
import org.flowable.cmmn.engine.impl.persistence.entity.HistoricCaseInstanceEntity;
import org.flowable.cmmn.engine.impl.util.CommandContextUtil;
import org.flowable.common.engine.api.FlowableException;
import org.flowable.common.engine.api.FlowableIllegalArgumentException;
Expand Down Expand Up @@ -44,11 +45,16 @@ public Object execute(CommandContext commandContext) {
}
// Check if case instance is still running
CmmnEngineConfiguration cmmnEngineConfiguration = CommandContextUtil.getCmmnEngineConfiguration(commandContext);
HistoricCaseInstance instance = cmmnEngineConfiguration.getHistoricCaseInstanceEntityManager().findById(caseInstanceId);
HistoricCaseInstanceEntity instance = cmmnEngineConfiguration.getHistoricCaseInstanceEntityManager().findById(caseInstanceId);

if (instance == null) {
throw new FlowableObjectNotFoundException("No historic case instance found with id: " + caseInstanceId, HistoricCaseInstance.class);
}
if (instance.isDeleted()) {
return null;
}


if (instance.getEndTime() == null) {
throw new FlowableException("Case instance is still running, cannot delete " + instance);
}
Expand Down
8 changes: 4 additions & 4 deletions .../src/main/java/org/flowable/cmmn/engine/impl/delegate/JsonPlanItemVariableAggregator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@
import org.flowable.variable.service.impl.types.DoubleType;
import org.flowable.variable.service.impl.types.InstantType;
import org.flowable.variable.service.impl.types.IntegerType;
import org.flowable.variable.service.impl.types.JodaDateTimeType;
import org.flowable.variable.service.impl.types.JodaDateType;
import org.flowable.variable.service.impl.types.JodaDateTimeFallbackType;
import org.flowable.variable.service.impl.types.JodaDateFallbackType;
import org.flowable.variable.service.impl.types.JsonType;
import org.flowable.variable.service.impl.types.LocalDateTimeType;
import org.flowable.variable.service.impl.types.LocalDateType;
Expand Down Expand Up @@ -140,8 +140,8 @@ public Object aggregateSingleVariable(DelegatePlanItemInstance planItemInstance,
case InstantType.TYPE_NAME:
case LocalDateType.TYPE_NAME:
case LocalDateTimeType.TYPE_NAME:
case JodaDateType.TYPE_NAME:
case JodaDateTimeType.TYPE_NAME:
case JodaDateFallbackType.TYPE_NAME:
case JodaDateTimeFallbackType.TYPE_NAME:
case UUIDType.TYPE_NAME:
// For all these types it is OK to use toString as their string representation is what we want to have
objectNode.put(targetVarName, varInstance.getValue().toString());
Expand Down
24 changes: 3 additions & 21 deletions ...owable-cmmn-rest/src/test/java/org/flowable/cmmn/rest/service/BaseSpringRestTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@
package org.flowable.cmmn.rest.service;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.fail;

import java.io.IOException;
import java.io.UncheckedIOException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.time.Instant;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
Expand Down Expand Up @@ -59,9 +59,6 @@
import org.flowable.idm.api.Group;
import org.flowable.idm.api.IdmIdentityService;
import org.flowable.idm.api.User;
import org.joda.time.DateTime;
import org.joda.time.format.DateTimeFormatter;
import org.joda.time.format.ISODateTimeFormat;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.extension.ExtendWith;
Expand Down Expand Up @@ -336,19 +333,11 @@ protected void assertErrorResult(String url, ObjectNode body, int statusCode) th
* Extract a date from the given string. Assertion fails when invalid date has been provided.
*/
protected Date getDateFromISOString(String isoString) {
DateTimeFormatter dateFormat = ISODateTimeFormat.dateTime();
try {
return dateFormat.parseDateTime(isoString).toDate();
} catch (IllegalArgumentException iae) {
fail("Illegal date provided: " + isoString);
return null;
}
return Date.from(Instant.parse(isoString));
}

protected String getISODateString(Date time) {
TimeZone tz = TimeZone.getTimeZone("UTC");
longDateFormat.setTimeZone(tz);
return longDateFormat.format(time);
return time.toInstant().toString();
}

protected String getIsoDateStringWithoutSeconds(Date time) {
Expand All @@ -363,13 +352,6 @@ protected String getIsoDateStringWithMS(Date time) {
return formatWithMS.format(time);
}

protected String getISODateStringWithTZ(Date date) {
if (date == null) {
return null;
}
return ISODateTimeFormat.dateTime().print(new DateTime(date));
}

protected String buildUrl(String[] fragments, Object... arguments) {
return URL_BUILDER.buildUrl(fragments, arguments);
}
Expand Down
2 changes: 1 addition & 1 deletion ...va/org/flowable/cmmn/rest/service/api/history/HistoricMilestoneInstanceResourcesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ private void assertHistoricMilestoneValues(HistoricMilestoneInstance expected, J
assertThat(actual.get("id").textValue()).isEqualTo(expected.getId());
assertThat(actual.get("name").textValue()).isEqualTo(expected.getName());
assertThat(actual.get("elementId").textValue()).isEqualTo(expected.getElementId());
assertThat(actual.get("timestamp").asText()).isEqualTo(getISODateStringWithTZ(expected.getTimeStamp()));
assertThat(actual.get("timestamp").asText()).isEqualTo(getISODateString(expected.getTimeStamp()));
assertThat(actual.get("caseInstanceId").textValue()).isEqualTo(expected.getCaseInstanceId());
assertThat(actual.get("caseDefinitionId").textValue()).isEqualTo(expected.getCaseDefinitionId());

Expand Down
Loading