D'fflib
WHATFeatures

Unit of Work 2.0

Being 14x faster than the original construct, the Unit of Work 2.0 fully focuses on relaxing developers from any DML related activity.

In our perspective the essence of the Unit of Work is to centralise and aggregate DML operations, ensure proper (error) transaction management - without duplicate and scattered try-catches and rollbacks - and simplify and improve readability of complex relationship-registrations. In line with this purpose, we've redesigned the UoW to strengthen these benefits while significantly improving performance and relaxing developers in all their DML related activities.

Main enrichments to the Unit of Work

Support for most DML operations, DMLOptions & SaveResults

Most Database methods are now supported, eliminating the need for custom IDoWork classes. Simplifying not only the usage and mocking, but also improving readability. See full list of supported DML operations below, including a.o. Priority, Immediate, Advanced Relationships, Approvals, Emails and (Standard) Events. Additionally, SaveResults are (optionally) available for when a developer needs to set DMLOptions or AllOrNone = false.

Full Database Context support

See the Database Context article for standardised way to achieve full access control (sharing and permissions). Our structure eliminates the need for project-specific overrides and 'awareness' of IDML outside of Unit of Work.

14x faster Unit of Work cycle times

Redesign of Map-initiations and numerous other optimisations resulted in a significant performance improvement. Across multiple projects we've benchmarked >14x faster operations .

Improved relationship registrations

  • Relationships can be registered per DML Operation to prevent resolving relations too soon.
  • A record instance can be registered as both new and dirty within the same Unit of Work.
  • Added validation to ensure all relationships are 'executed' (e.g. register relationship, but not the child record).

Deprecation of on...-events

In our perspective these methods only caused overhead and complexity, while we never needed these in any project and believe they are in conflict with the modularity principle where one doesn't need to know how a called method performs.

Minor tweaks and fixes

  • Increased test coverage (68% > 98%) after migrating to project-independent SObjectTypes.
  • Added registration validations to prevent invalid combinations (e.g. publishing a non-Event).
  • Allowing reuse of the same UoW instance, by resetting the work after commitWork().
  • Squashed nasty bugs, like registerDirty overriding previous registrations of the same record when no dirtyFields are provided.

Full methods list

Below is the full method comparison between apex-common and D'fflib's dfflib_ISObjectUnitOfWork, indicating the differences and similarities.

Method signatureapex-commonD'fflib
commitWork()
hasWork()

Constructors

  • dfflib_SObjectUnitOfWork()
  • dfflib_SObjectUnitOfWork(List<SObjectType> sObjTypes)
  • dfflib_SObjectUnitOfWork(List<SObjectType> sObjTypes, fflib_SObjectUnitOfWork.IDML dml)
  • dfflib_SObjectUnitOfWork(dfflib_Database.Context)
  • dfflib_SObjectUnitOfWork(List<SObjectType> sObjTypes, dfflib_Database.Context)












setContext(dfflib_Database.Context)

Register New/Insert

  • registerNew(SObject)
  • registerNew(List<SObject>)
  • registerNew(SObject, Schema.SObjectField, SObject)
  • registerNewDmlOptions(Schema.SObjectType, Database.DMLOptions)
  • registerNewAllOrNone(Schema.SObjectType, Boolean)












Register Dirty/Update

  • registerDirty(SObject)
  • registerDirty(List<SObject>)
  • registerDirty(SObject, Schema.SObjectField, SObject)
  • registerDirty(SObject, List<SObjectField>)
  • registerDirty(SObject, List<SObjectField>, Schema.SObjectField, SObject)
  • registerDirty(List<SObject>, List<SObjectField>)
  • registerDirtyDmlOptions(Schema.SObjectType, Database.DMLOptions)
  • registerDirtyAllOrNone(Schema.SObjectType, Boolean)


















Register Upsert (deprecated)

  • registerUpsert(SObject)
  • registerUpsert(List<SObject>)

Register Upsert

  • registerUpsert(SObject, Schema.SObjectField externalIdField )
  • registerUpsert(List<SObject>, Schema.SObjectField externalIdField )
  • registerUpsert( SObject record, SObjectField externalIdField, SObjectField relatedToParentField, SObject relatedToParentRecord )
  • registerUpsertedAllOrNone(Schema.SObjectType, Boolean)










Register Delete/Recyclebin

  • registerDeleted(SObject)
  • registerDeleted(List<SObject>)
  • registerEmptyRecycleBin(SObject)
  • registerEmptyRecycleBin(List<SObject>)
  • registerPermanentlyDeleted(SObject)
  • registerPermanentlyDeleted(List<SObject>)
  • registerDeletedAllOrNone(Schema.SObjectType, Boolean)
















Register Undelete

  • registerUndeleted(SObject)
  • registerUndeleted(List<SObject>)
  • registerUndeletedAllOrNone(Schema.SObjectType, Boolean)

Register Custom Platform Event (AsyncProcess__e)

Register Standard Platform Event (BatchApexErrorEvent)

  • registerPublishAfterFailureTransaction(SObject)
  • registerPublishAfterFailureTransaction(List<SObject>)
  • registerPublishAfterSuccessTransaction(SObject)
  • registerPublishAfterSuccessTransaction(List<SObject>)
  • registerPublishBeforeTransaction(SObject)
  • registerPublishBeforeTransaction(List<SObject>)


Register Work

  • registerWork(dfflib_SObjectUnitOfWork.IDoWork)

Register Relationships

  • registerRelationship(SObject, Schema.SObjectField, SObject)
  • registerRelationship(SObject, Schema.SObjectField, SObject, dfflib_SObjectUnitOfWork.DMLActions)
  • registerRelationship(SObject, Schema.SObjectField, Schema.SObjectField, Object)
  • registerRelationship(SObject, Schema.SObjectField, Schema.SObjectField, Object, dfflib_SObjectUnitOfWork.DMLActions)
  • registerRelationship(Messaging.SingleEmailMessage, SObject)
  • registerRelationship(Approval.ProcessRequest, SObject)














Register Approval Process

  • registerApprovalProcess(Approval.ProcessRequest)
  • registerApprovalProcess(Approval.ProcessRequest, SObject)

Register Email

  • registerEmail(Messaging.Email)
  • registerEmail(Messaging.SingleEmailMessage, SObject)




Register Immediate

  • registerDeletedImmediate(SObject)
  • registerDeletedImmediate(List<SObject>)
  • registerDirtyImmediate(SObject)
  • registerDirtyImmediate(List<SObject>)
  • registerNewImmediate(SObject)
  • registerNewImmediate(List<SObject>)

Register Priority

(example)
  • registerPriorityDeleted(SObject)
  • registerPriorityDeleted(List<SObject>)
  • registerPriorityDirty(SObject)
  • registerPriorityDirty(List<SObject>)
  • registerPriorityDirty(SObject, Schema.SObjectField, SObject)
  • registerPriorityNew(SObject)
  • registerPriorityNew(List<SObject>)
  • registerPriorityNew(SObject, Schema.SObjectField, SObject)
  • registerPriorityUpsert(SObject, Schema.SObjectField externalIdField)
  • registerPriorityUpsert(List<SObject>, Schema.SObjectField externalIdField)

SaveResults

(example)
  • setSaveResultsRequired(Boolean)
  • getApprovalProcessResults()
  • getDeletedResults(Schema.SObjectType)
  • getDirtyResults(Schema.SObjectType)
  • getEmailResults()
  • getEmptyRecycleBinResults(Schema.SObjectType)
  • getNewResults(Schema.SObjectType)
  • getPublishResults(Schema.SObjectType)
  • getUndeletedResults(Schema.SObjectType)
  • getUpsertResults(Schema.SObjectType)

Reset Unit of Work

  • resetSaveResults()
  • resetWork()

Except for the listed items, the content on this site is licensed under CC-BY-NC-4.0
and allows sharing, provided an appropriate credit and link to source.

On this page