Skip to content

Commit

Permalink
Merge pull request #931 from BroadleafCommerce/qa-2760-simple-paged-l…
Browse files Browse the repository at this point in the history
…istgrids

Large ResultSet and Large Query Volume Performance Improvements
  • Loading branch information
danielcolgrove committed Jun 30, 2017
2 parents f02fc32 + 59441dd commit e216da5
Show file tree
Hide file tree
Showing 72 changed files with 3,607 additions and 186 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -233,30 +233,7 @@ public Predicate buildPredicate(CriteriaBuilder builder,
})
));
}
if (ArrayUtils.isEmpty(persistencePackage.getSectionCrumbs()) &&
(!cto.getCriteriaMap().containsKey("id") || CollectionUtils.isEmpty(cto.getCriteriaMap().get("id").getFilterValues()))) {
//Add special handling for product list grid fetches
boolean hasExplicitSort = false;
for (FilterAndSortCriteria filter : cto.getCriteriaMap().values()) {
hasExplicitSort = filter.getSortDirection() != null;
if (hasExplicitSort) {
break;
}
}
if (!hasExplicitSort) {
FilterAndSortCriteria filter = cto.get("id");
filter.setNullsLast(false);
filter.setSortAscending(true);
}
try {
extensionManager.getProxy().initiateFetchState();
return helper.getCompatibleModule(OperationType.BASIC).fetch(persistencePackage, cto);
} finally {
extensionManager.getProxy().endFetchState();
}
} else {
return helper.getCompatibleModule(OperationType.BASIC).fetch(persistencePackage, cto);
}
return helper.getCompatibleModule(OperationType.BASIC).fetch(persistencePackage, cto);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
/*
* #%L
* BroadleafCommerce Admin Module
* %%
* Copyright (C) 2009 - 2017 Broadleaf Commerce
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package org.broadleafcommerce.admin.server.service.handler;

import org.broadleafcommerce.common.exception.ServiceException;
import org.broadleafcommerce.common.presentation.client.OperationType;
import org.broadleafcommerce.common.sandbox.SandBoxHelper;
import org.broadleafcommerce.core.catalog.domain.ProductOptionImpl;
import org.broadleafcommerce.core.catalog.domain.ProductOptionValue;
import org.broadleafcommerce.openadmin.dto.CriteriaTransferObject;
import org.broadleafcommerce.openadmin.dto.DynamicResultSet;
import org.broadleafcommerce.openadmin.dto.PersistencePackage;
import org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao;
import org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter;
import org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper;
import org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FieldPathBuilder;
import org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping;
import org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.Restriction;
import org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.predicate.PredicateProvider;
import org.springframework.stereotype.Component;

import java.util.List;

import javax.annotation.Resource;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.From;
import javax.persistence.criteria.Path;
import javax.persistence.criteria.Predicate;

/**
* @author Jeff Fischer
*/
@Component("blProductOptionValuesCustomPersistenceHandler")
public class ProductOptionValuesCustomPersistenceHandler extends CustomPersistenceHandlerAdapter {

@Resource(name="blSandBoxHelper")
protected SandBoxHelper sandBoxHelper;

@Override
public Boolean canHandleFetch(PersistencePackage persistencePackage) {
//Make sure this is not only the right entity, but that it's also a ToOne lookup from AdminBasicOperationsController#showSelectCollectionItem()
boolean isQualified;
String ceilingEntityFullyQualifiedClassname = persistencePackage.getCeilingEntityFullyQualifiedClassname();
try {
Class testClass = Class.forName(ceilingEntityFullyQualifiedClassname);
isQualified = ProductOptionValue.class.isAssignableFrom(testClass);
} catch (ClassNotFoundException e) {
isQualified = false;
}
if (isQualified) {
isQualified = getOptionKey(persistencePackage) != null;
}
return isQualified;
}

@Override
public DynamicResultSet fetch(PersistencePackage persistencePackage, CriteriaTransferObject cto, DynamicEntityDao
dynamicEntityDao, RecordHelper helper) throws ServiceException {
Long optionId = getOptionKey(persistencePackage);
if (optionId != null) {
FilterMapping filterMapping = new FilterMapping().withDirectFilterValues(sandBoxHelper.mergeCloneIds(ProductOptionImpl.class, optionId)).withRestriction(new Restriction()
.withPredicateProvider(new PredicateProvider() {
public Predicate buildPredicate(CriteriaBuilder builder, FieldPathBuilder fieldPathBuilder, From root,
String ceilingEntity, String fullPropertyName, Path explicitPath, List directValues) {
return root.get("productOption").get("id").in(directValues);
}
}));
cto.getAdditionalFilterMappings().add(filterMapping);
}
return helper.getCompatibleModule(OperationType.BASIC).fetch(persistencePackage, cto);
}

protected Long getOptionKey(PersistencePackage persistencePackage) {
String key = "option=";
Long response = null;
for (String criteria : persistencePackage.getCustomCriteria()) {
if (criteria.startsWith(key)) {
response = Long.parseLong(criteria.substring(key.length(), criteria.length()));
break;
}
}
return response;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,19 @@
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.broadleafcommerce.common.exception.ServiceException;
import org.broadleafcommerce.common.presentation.client.LookupType;
import org.broadleafcommerce.common.presentation.client.OperationType;
import org.broadleafcommerce.common.presentation.client.PersistencePerspectiveItemType;
import org.broadleafcommerce.common.presentation.client.SupportedFieldType;
import org.broadleafcommerce.common.presentation.client.VisibilityEnum;
import org.broadleafcommerce.common.sandbox.SandBoxHelper;
import org.broadleafcommerce.common.util.BLCCollectionUtils;
import org.broadleafcommerce.common.util.EfficientLRUMap;
import org.broadleafcommerce.common.util.TypedTransformer;
import org.broadleafcommerce.common.util.dao.DynamicDaoHelperImpl;
import org.broadleafcommerce.core.catalog.domain.Product;
import org.broadleafcommerce.core.catalog.domain.ProductOption;
import org.broadleafcommerce.core.catalog.domain.ProductOptionImpl;
import org.broadleafcommerce.core.catalog.domain.ProductOptionValue;
import org.broadleafcommerce.core.catalog.domain.ProductOptionValueImpl;
import org.broadleafcommerce.core.catalog.domain.Sku;
Expand All @@ -58,9 +61,11 @@
import org.broadleafcommerce.openadmin.server.dao.DynamicEntityDao;
import org.broadleafcommerce.openadmin.server.service.handler.CustomPersistenceHandlerAdapter;
import org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManager;
import org.broadleafcommerce.openadmin.server.service.persistence.PersistenceManagerFactory;
import org.broadleafcommerce.openadmin.server.service.persistence.module.InspectHelper;
import org.broadleafcommerce.openadmin.server.service.persistence.module.PersistenceModule;
import org.broadleafcommerce.openadmin.server.service.persistence.module.RecordHelper;
import org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.CriteriaTranslator;
import org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FieldPath;
import org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FieldPathBuilder;
import org.broadleafcommerce.openadmin.server.service.persistence.module.criteria.FilterMapping;
Expand All @@ -79,15 +84,17 @@
import java.util.List;
import java.util.Map;

import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import javax.persistence.EntityManager;
import javax.persistence.PersistenceContext;
import javax.persistence.TypedQuery;
import javax.persistence.criteria.CriteriaBuilder;
import javax.persistence.criteria.From;
import javax.persistence.criteria.Path;
import javax.persistence.criteria.Predicate;

import static com.google.common.base.CharMatcher.DIGIT;

/**
* @author Phillip Verheyden
*
Expand All @@ -105,6 +112,9 @@ public class SkuCustomPersistenceHandler extends CustomPersistenceHandlerAdapter
@Value("${cache.entity.dao.metadata.ttl}")
protected int cacheEntityMetaDataTtl;

@Value("${use.to.one.lookup.sku.product.option.value:false}")
protected boolean useToOneLookupSkuProductOptionValue = false;

protected long lastCacheFlushTime = System.currentTimeMillis();

protected static final Map<String, Map<String, FieldMetadata>> METADATA_CACHE =
Expand All @@ -130,6 +140,12 @@ public class SkuCustomPersistenceHandler extends CustomPersistenceHandlerAdapter
@PersistenceContext(unitName = "blPU")
protected EntityManager em;

@Resource(name = "blCriteriaTranslator")
protected CriteriaTranslator criteriaTranslator;

@Resource(name = "blSandBoxHelper")
protected SandBoxHelper sandBoxHelper;

@Override
public Boolean canHandleInspect(PersistencePackage persistencePackage) {
return canHandle(persistencePackage, persistencePackage.getPersistencePerspective().getOperationTypes()
Expand Down Expand Up @@ -215,8 +231,11 @@ public DynamicResultSet inspect(PersistencePackage persistencePackage, DynamicEn
//Grab the default properties for the Sku
properties = helper.getSimpleMergedProperties(SkuImpl.class.getName(), persistencePerspective);


if (persistencePackage.getCustomCriteria() == null || persistencePackage.getCustomCriteria().length == 0) {
boolean isFirstCriteriaNAN = persistencePackage.getCustomCriteria() == null || persistencePackage.getCustomCriteria().length == 0;
if (!isFirstCriteriaNAN && useToOneLookupSkuProductOptionValue) {
isFirstCriteriaNAN = !DIGIT.matchesAllOf(persistencePackage.getCustomCriteria()[0]);
}
if (isFirstCriteriaNAN) {
//look up all the ProductOptions and then create new fields for each of them
List<ProductOption> options = catalogService.readAllProductOptions();
int order = 0;
Expand Down Expand Up @@ -395,7 +414,14 @@ public Property getBlankConsolidatedOptionProperty() {
* @return
*/
public FieldMetadata createIndividualOptionField(ProductOption option, int order) {
if (useToOneLookupSkuProductOptionValue) {
return createToOneIndividualOptionField(option, order);
} else {
return createExplicitEnumerationIndividualOptionField(option, order);
}
}

protected FieldMetadata createExplicitEnumerationIndividualOptionField(ProductOption option, int order) {
BasicFieldMetadata metadata = new BasicFieldMetadata();
List<ProductOptionValue> allowedValues = option.getAllowedValues();
if (CollectionUtils.isNotEmpty(allowedValues)) {
Expand All @@ -405,7 +431,7 @@ public FieldMetadata createIndividualOptionField(ProductOption option, int order
metadata.setAvailableToTypes(getPolymorphicClasses(SkuImpl.class));
metadata.setForeignKeyCollection(false);
metadata.setMergedPropertyType(MergedPropertyType.PRIMARY);

//Set up the enumeration based on the product option values
String[][] optionValues = new String[allowedValues.size()][2];
for (int i = 0; i < allowedValues.size(); i++) {
Expand All @@ -414,7 +440,7 @@ public FieldMetadata createIndividualOptionField(ProductOption option, int order
optionValues[i][1] = value.getAttributeValue();
}
metadata.setEnumerationValues(optionValues);

metadata.setName(PRODUCT_OPTION_FIELD_PREFIX + option.getId());
metadata.setFriendlyName(option.getLabel());
metadata.setGroup("productOption_group");
Expand All @@ -432,6 +458,62 @@ public FieldMetadata createIndividualOptionField(ProductOption option, int order
return null;
}

/**
* Using a ToOne lookup performs much better for large product option value lists, speeds up initial page load,
* and is generally more accurate in relation to option value updates and how they impact available selections and cache.
*
* @param option
* @param order
* @return
*/
protected FieldMetadata createToOneIndividualOptionField(ProductOption option, int order) {
PersistenceManager persistenceManager = PersistenceManagerFactory.getPersistenceManager();
FilterMapping filterMapping = new FilterMapping().withDirectFilterValues(
sandBoxHelper.mergeCloneIds(ProductOptionImpl.class, option.getId())).withRestriction(new Restriction()
.withPredicateProvider(new PredicateProvider() {
public Predicate buildPredicate(CriteriaBuilder builder, FieldPathBuilder fieldPathBuilder, From root,
String ceilingEntity, String fullPropertyName, Path explicitPath, List directValues) {
return root.get("productOption").get("id").in(directValues);
}
}));
List<FilterMapping> mappings = new ArrayList<FilterMapping>();
mappings.add(filterMapping);
TypedQuery<Serializable> countQuery = criteriaTranslator.translateCountQuery(persistenceManager.getDynamicEntityDao(),
ProductOptionValueImpl.class.getName(), mappings);
Long count = (Long) countQuery.getSingleResult();
BasicFieldMetadata metadata = null;
if (count > 0) {
metadata = new BasicFieldMetadata();
metadata.setFieldType(SupportedFieldType.ADDITIONAL_FOREIGN_KEY);
metadata.setSecondaryType(SupportedFieldType.INTEGER);
metadata.setForeignKeyProperty("id");
metadata.setForeignKeyClass(ProductOptionValueImpl.class.getName());
metadata.setForeignKeyDisplayValueProperty("attributeValue");
metadata.setLookupDisplayProperty("attributeValue");
metadata.setForeignKeyCollection(false);
metadata.setCustomCriteria(new String[]{"option=" + String.valueOf(option.getId())});
metadata.setName(PRODUCT_OPTION_FIELD_PREFIX + option.getId());
metadata.setFriendlyName(option.getLabel());
metadata.setGroup("productOption_group");
metadata.setGroupOrder(-1);
metadata.setOrder(order);
metadata.setExplicitFieldType(SupportedFieldType.ADDITIONAL_FOREIGN_KEY);
metadata.setProminent(false);
metadata.setVisibility(VisibilityEnum.FORM_EXPLICITLY_SHOWN);
metadata.setReadOnly(false);
//these may not be actually required, but the CPH has this as a requirement for parsing the data, so we'll stick with it here
metadata.setRequiredOverride(true);
metadata.setLookupType(LookupType.STANDARD);
metadata.setMutable(true);
metadata.setInheritedFromType(SkuImpl.class.getName());
metadata.setAvailableToTypes(getPolymorphicClasses(SkuImpl.class, em, useCache()));
metadata.setMergedPropertyType(MergedPropertyType.PRIMARY);
metadata.setTargetClass(SkuImpl.class.getName());
metadata.setFieldName(PRODUCT_OPTION_FIELD_PREFIX + option.getId());
}
return metadata;
}

@SuppressWarnings("unchecked")
@Override
public DynamicResultSet fetch(PersistencePackage persistencePackage, CriteriaTransferObject cto, DynamicEntityDao dynamicEntityDao, RecordHelper helper) throws ServiceException {
Expand Down Expand Up @@ -470,6 +552,7 @@ public ProductOptionValue transform(Object input) {
Property optionProperty = new Property();
optionProperty.setName(PRODUCT_OPTION_FIELD_PREFIX + value.getProductOption().getId());
optionProperty.setValue(value.getId().toString());
optionProperty.setDisplayValue(value.getAttributeValue());
entity.addProperty(optionProperty);
}

Expand Down Expand Up @@ -629,6 +712,17 @@ public Entity update(PersistencePackage persistencePackage, DynamicEntityDao dyn
}
}

protected String[] getPolymorphicClasses(Class<?> clazz, EntityManager em, boolean useCache) {
DynamicDaoHelperImpl helper = new DynamicDaoHelperImpl();
Class<?>[] classes = helper.getAllPolymorphicEntitiesFromCeiling(clazz,
helper.getSessionFactory((HibernateEntityManager) em), true, useCache);
String[] result = new String[classes.length];
for (int i = 0; i < classes.length; i++) {
result[i] = classes[i].getName();
}
return result;
}

/**
* This initially removes all of the product option values that are currently related to the Sku and then re-associates
* the {@link ProductOptionValue}s
Expand Down

0 comments on commit e216da5

Please sign in to comment.