Add withUserMode() and withSystemMode() to SObjectSelector and QueryFactory
#435
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…eryFactory ## fflib_QueryFactory When the operation mode is set, the `enforceFLS` is set to false to skip the fflib_SecurityUtils checks. Alternatively, when you call `setEnforceFLS(true)`, the operation mode is set to null, and fflib_SecurityUtils checks are respected. ### Specify `WITH USER_MODE` ```java fflib_QueryFactory qf = new fflib_QueryFactory(Account.SObjectType); qf.withUserMode(); qf.getFLSEnforcement(); // USER_MODE qf.setFLSEnforcement(fflib_QueryFactory.FLSEnforcement.USER_MODE); qf.getFLSEnforcement(); // USER_MODE ``` ### Specify `WITH SYSTEM_MODE` Salesforce uses `SYSTEM_MODE` as the default operation mode when not specified in the query. `withSystemMode()` allows users to make their queries explicit if desired. ```java fflib_QueryFactory qf = new fflib_QueryFactory(Account.SObjectType); qf.withSystemMode(); qf.getFLSEnforcement(); // SYSTEM_MODE // SELECT Id FROM Account WITH SYSTEM_MODE qf.setFLSEnforcement(fflib_QueryFactory.FLSEnforcement.SYSTEM_MODE); qf.getFLSEnforcement(); // SYSTEM_MODE ``` ### Switch back to `LEGACY` or `NONE` ```java fflib_QueryFactory qf = new fflib_QueryFactory(Account.SObjectType); qf.withSystemMode(); qf.getFLSEnforcement(); // SYSTEM_MODE qf.setEnforceFLS(true); qf.getFLSEnforcement(); // LEGACY // OR qf.setEnforceFLS(FLSEnforcement.LEGACY); // OR qf.setEnforceFLS(false); qf.getFLSEnforcement(); // NONE // OR qf.setEnforceFLS(FLSEnforcement.NONE); ``` ## fflib_SObjectSelector `isEnforcingFLS()` and `isEnforcingCRUD()` now consider the `DataAccess` to determine their result instead of directly returning the values of `m_enforceFLS` and `m_enforceCRUD`. This allows the user to get the correct state from the methods, regardless if they are using legacy enforcement or one of the new operation modes. ### Specify `USER_MODE` ```java AccountSelector selector = new AccountSelector(); selector.withUserMode(); selector.isEnforcingCRUD(); // true selector.isEnforcingFLS(); // true ``` ### Specify `SYSTEM_MODE` ```java AccountSelector selector = new AccountSelector(); selector.withSystemMode(); selector.isEnforcingCRUD(); // false selector.isEnforcingFLS(); // false ``` ### Switch back to `LEGACY` ```java AccountSelector selector = new AccountSelector(); selector.withSystemMode(); selector.isEnforcingCRUD(); // false selector.isEnforcingFLS(); // false selector.getDataAccess(); // SYSTEM_MODE selector.enforceFLS(); selector.isEnforcingCRUD(): // true selector.isEnforcingFLS(); // true selector.getDataAccess(); // LEGACY // OR selector.setDataAccess(fflib_SObjectSelector.DataAccess.LEGACY); selector.getDataAccess(); // LEGACY ``` ## Add ### fflib_QueryFactory - void withUserMode() - void withSystemMode() - fflib_QueryFactory.FLSEnforcement getFLSEnforcement() - Boolean isEnforcingFLS(); ### fflib_SObjectSelector - void withUserMode() - void withSystemMode() ## Change ### fflib_QueryFactoryTest - Replace System asserts with new Assert class ### fflib_SObjectSelector - Update `enforceFLS()` to set `m_dataAccess` to `LEGACY` - Update `setDataAccess()` to revert `m_enforceCRUD` to true when `m_dataAccess` is `LEGACY` - Update `isEnforcingFLS()` to return true when `m_dataAccess` is set to `USER_MODE` - Update `isEnforcingCRUD()` to return true when `m_dataAccess` is set to `USER_MODE` ### fflib_SObjectSelectorTest - Replace System asserts with new Assert class
|
Hi @daveespo - Should I update this pull request to include the builder style methods in master? Or has it been decided to not include them in the API? |
|
Hi @chazwatkins -- I didn't explicitly close out this PR -- it was implicitly closed when I merged the branch it targeted. Can you reopen it and target it at Don't go changing anything in this branch yet. First, we want to get PR #437 and your #436 merged in .. and those will create merge conflicts with this branch .. let's sort out what we want to keep and what should get removed on this PR after those other two PRs are merged |
|
Sounds good. I'll wait for the other PRs to get merged and submit this one to master |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
withUserMode()andwithSystemMode()tofflib_SObjectSelectorandfflib_QueryFactoryfflib_QueryFactory
Specify
WITH USER_MODESpecify
WITH SYSTEM_MODESalesforce uses
SYSTEM_MODEas the default operation mode when not specified in the query.withSystemMode()allows users to make their queries explicit if desired.Switch back to
LEGACYorNONEfflib_SObjectSelector
isEnforcingFLS()andisEnforcingCRUD()now consider theDataAccessto determine their result instead of directly returning the values ofm_enforceFLSandm_enforceCRUD. This allows the user to get the correct state from the methods, regardless if they are using legacy enforcement or one of the new operation modes.Specify
USER_MODESpecify
SYSTEM_MODESwitch back to
LEGACYAdd
fflib_QueryFactory
fflib_SObjectSelector
Change
fflib_QueryFactoryTest
fflib_SObjectSelector
enforceFLS()to setm_dataAccesstoLEGACYsetDataAccess()to revertm_enforceCRUDto true whenm_dataAccessisLEGACYisEnforcingFLS()to return true whenm_dataAccessis set toUSER_MODEisEnforcingCRUD()to return true whenm_dataAccessis set toUSER_MODEfflib_SObjectSelectorTest
This change is