Skip to content

Commit

Permalink
Implemented: Add transaction timeout default properties for screen wi…
Browse files Browse the repository at this point in the history 
…dget

(OFBIZ-11190)

Currently when you rendering a screen, the transaction timeout would be resolve from the context or use default value (60s)
I reviewed this code part to reorganize timeout resolution on dedicate function (transaction timeout on widget screen is pre-apache)
and introduce possibility to set a default value by properties on 'widget.property' with name 'widget.screen.transaction.defaultTimeout'.

git-svn-id: https://svn.apache.org/repos/asf/ofbiz/ofbiz-framework/trunk@1867620 13f79535-47bb-0310-9956-ffa450edef68
  • Loading branch information
@nmalin
nmalin committed Sep 27, 2019
1 parent 9d9d633 commit 39f5dda
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 34 deletions.
3 changes: 3 additions & 0 deletions framework/widget/config/widget.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,6 @@ widget.defaultNoConditionFind=N
# When you don't displaying freemarker stacktrace, you can replace it by an other message
# by default it use ∎ but you can set what you want, like 'ERROR', '##' or ' '
#widget.freemarker.template.exception.message=

#Default transaction timeout to rendering screen
#widget.screen.transaction.defaultTimeout=60
76 changes: 42 additions & 34 deletions framework/widget/src/main/java/org/apache/ofbiz/widget/model/ModelScreen.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

import org.apache.ofbiz.base.util.Debug;
import org.apache.ofbiz.base.util.UtilGenerics;
import org.apache.ofbiz.base.util.UtilProperties;
import org.apache.ofbiz.base.util.UtilValidate;
import org.apache.ofbiz.base.util.UtilXml;
import org.apache.ofbiz.base.util.string.FlexibleStringExpander;
Expand Down Expand Up @@ -120,44 +121,12 @@ public void renderScreenString(Appendable writer, Map<String, Object> context, S
context.put("nullField", GenericEntity.NULL_FIELD);

// wrap the whole screen rendering in a transaction, should improve performance in querying and such
Map<String, String> parameters = UtilGenerics.cast(context.get("parameters"));
boolean beganTransaction = false;
int transactionTimeout = -1;
if (parameters != null) {
String transactionTimeoutPar = parameters.get("TRANSACTION_TIMEOUT");
if (transactionTimeoutPar != null) {
try {
transactionTimeout = Integer.parseInt(transactionTimeoutPar);
} catch (NumberFormatException nfe) {
String msg = "TRANSACTION_TIMEOUT parameter for screen [" + this.sourceLocation + "#" + getName() + "] is invalid and it will be ignored: " + nfe.toString();
Debug.logWarning(msg, module);
}
}
}

if (transactionTimeout < 0 && !transactionTimeoutExdr.isEmpty()) {
// no TRANSACTION_TIMEOUT parameter, check screen attribute
String transactionTimeoutStr = transactionTimeoutExdr.expandString(context);
if (UtilValidate.isNotEmpty(transactionTimeoutStr)) {
try {
transactionTimeout = Integer.parseInt(transactionTimeoutStr);
} catch (NumberFormatException e) {
Debug.logWarning(e, "Could not parse transaction-timeout value, original=[" + transactionTimeoutExdr + "], expanded=[" + transactionTimeoutStr + "]", module);
}
}
}

try {
// If transaction timeout is not present (i.e. is equal to -1), the default transaction timeout is used
// If transaction timeout is present, use it to start the transaction
// If transaction timeout is set to zero, no transaction is started
// Start a transaction if needed
if (useTransaction) {
if (transactionTimeout < 0) {
beganTransaction = TransactionUtil.begin();
}
if (transactionTimeout > 0) {
beganTransaction = TransactionUtil.begin(transactionTimeout);
}
beganTransaction = TransactionUtil.begin(resolveTransactionTimeout(context));
}

// render the screen, starting with the top-level section
Expand Down Expand Up @@ -191,6 +160,45 @@ public Delegator getDelegator(Map<String, Object> context) {
Delegator delegator = (Delegator) context.get("delegator");
return delegator;
}

/**
* Resolve the transaction timeout used from a screen with the following step :
* * scan parameters.TRANSACTION_TIMEOUT on the context
* * expand transaction-timeout attribute on screen definition with the context
* * use default value
* if the transaction timeout found is <=0 use the default value
* @param context
* @return
*/
private int resolveTransactionTimeout(Map<String, Object> context) {
Map<String, String> parameters = UtilGenerics.cast(context.get("parameters"));
int transactionTimeout = -1;
if (parameters != null) {
String transactionTimeoutPar = parameters.get("TRANSACTION_TIMEOUT");
if (transactionTimeoutPar != null) {
try {
transactionTimeout = Integer.parseInt(transactionTimeoutPar);
} catch (NumberFormatException nfe) {
String msg = "TRANSACTION_TIMEOUT parameter for screen [" + this.sourceLocation + "#" + getName() + "] is invalid and it will be ignored: " + nfe.toString();
Debug.logWarning(msg, module);
}
}
}

// no TRANSACTION_TIMEOUT parameter, check screen attribute
if (transactionTimeout < 0 && !transactionTimeoutExdr.isEmpty()) {
String transactionTimeoutStr = transactionTimeoutExdr.expandString(context);
if (UtilValidate.isNotEmpty(transactionTimeoutStr)) {
try {
transactionTimeout = Integer.parseInt(transactionTimeoutStr);
} catch (NumberFormatException e) {
Debug.logWarning(e, "Could not parse transaction-timeout value, original=[" + transactionTimeoutExdr + "], expanded=[" + transactionTimeoutStr + "]", module);
}
}
}
return transactionTimeout > 0 ? transactionTimeout:
UtilProperties.getPropertyAsInteger("widget", "widget.screen.transaction.defaultTimeout", 60);
}
}


0 comments on commit 39f5dda

Please sign in to comment.