DeviousBard
commented
7 years ago I'd like to have a discussion on a possible solution to this problem.
While attempting to fix this issue on my own, I realized most of the problem seems to be that the "fflib_SObjectSelector" class is not completely decoupled from the new fflib_QueryFactory class. The query factory's responsibility should be to generate the entire SOQL query. However, there is a good bit of logic that still resides in the "fflib_SObjectSelector" that is generating parts of the SOQL query.
I moved all of the logic out of the "fflib_SObjectSelector", and changed the query factory's constructor to take the selector as a parameter. I also moved all of the Boolean flags used to configure the query factory that affect the query generation up to the query factory class (i.e. CRUD assertion, FLS enforcement, sorting of select fields, inclusion of the selector's query fields, and inclusion of the selector's default "order by"). I also removed those parameters from the query factory constructors in favor of "applying" them to the query factory (in builder fashion). I think it was better to default them, and just let the caller change the ones that need to overridden. There are just too many combinations of parameters to make multiple constructors effective.
The changes I made also made it easier to change the way subselect queries can be added to a query factory.
This is the way a call to create a query with a subselect must be coded with the existing code base:
fflib_QueryFactory opportunitiesQueryFactory = newQueryFactory(true);
fflib_QueryFactory lineItemsQueryFactory =
new OpportunityLineItemsSelector().
addQueryFactorySubselect(opportunitiesQueryFactory);
new PricebookEntriesSelector().
configureQueryFactoryFields(lineItemsQueryFactory, 'PricebookEntry');
new ProductsSelector().
configureQueryFactoryFields(lineItemsQueryFactory, 'PricebookEntry.Product2');
new PricebooksSelector().
configureQueryFactoryFields(lineItemsQueryFactory, 'PricebookEntry.Pricebook2');
return (List<Opportunity>) Database.query(
opportunitiesQueryFactory
.setCondition('id in :idSet')
.addOrdering('Type', fflib_QueryFactory.SortOrder.DESCENDING)
.toSOQL());
With the changes that I've made, here's how the same query can be created:
String query = newQueryFactory()
.withoutFLSEnforcement()
.withCRUDAssertion()
.withSelectorFieldsIncluded()
.withoutSelectorOrderByIncluded()
.withSelectFieldsSorted()
.subselect(new OpportunityLineItemsSelector().newQueryFactory()
.withSelectorFieldsIncluded()
.withSelectFieldsSorted()
.selectRelatedFields(new PricebookEntriesSelector(), 'PricebookEntry')
.selectRelatedFields(new ProductsSelector(), 'PricebookEntry.Product2')
.selectRelatedFields(new PricebooksSelector(), 'PricebookEntry.Pricebook2')
)
.setCondition('Id in :idSet')
.addOrdering('Type', fflib_QueryFactory.SortOrder.ASCENDING)
.toSOQL();
return (List<Opportunity>) Database.query(query);
Notice how the Boolean configuration flags are added using the ".with" or ".without" notation. I think it makes the code a bit more explicit as to what the intent is.
Attached are the three class files I changed to make this work as shown above.
fflib_ISObjectSelector.cls fflib_SObjectSelector.cls fflib_QueryFactory.cls
o-lexi
afawcett
thegogz
glenncoppens
rsoesemann
yurybond
daveespo
Currently, a selector's default "order by" (from the "getOrderBy()" method) is always added first in the list of fields in the Query Factory's order list when the "newQueryFactory()" method is called.
Typically, a custom query is going to require its own unique ordering fields that do not include the defaults. There is no way to override the default "order by" behavior in the selector class, other than partially building a query factory, clearing the order list, and then adding the actual order fields to sort by -- which is extremely awkward, and makes the code difficult to read.
To make matters worse, even removing the "getOrderBy()" method does not fix the problem, because its absence causes a default ordering of "Name ASC NULLS FIRST" to be pre-pended to the order list.
The attached "AccountsSelector.cls" demonstrates the issue.
It has the following default "order by" method:
It has the following selector method:
I would expect the resulting query from the selector method to look like this:
SELECT BillingAddress, Description, Id, Name FROM Account WHERE BillingState IN :billingStates ORDER BY BillingState ASC NULLS FIRST LIMIT 20But instead, due to the default "order by" in the selector, the query looks like this ("Id ASC NULLS FIRST" is pre-pended to the "ORDER BY" list):
SELECT BillingAddress, Description, Id, Name FROM Account WHERE BillingState IN :billingStates ORDER BY Id ASC NULLS FIRST, BillingState ASC NULLS FIRST LIMIT 20Completely removing the "getOrderBy()" method results in the following query (the "Id" field is now replaced by the "Name" field at the beginning of the "ORDER BY"):
SELECT BillingAddress, Description, Id, Name FROM Account WHERE BillingState IN :billingStates ORDER BY Name ASC NULLS FIRST, BillingState ASC NULLS FIRST LIMIT 20Neither of the alternative SOQL queries achieves the desired result, which would be to sort the account list by the "BillingState" field only.