identity_cache icon indicating copy to clipboard operation
identity_cache copied to clipboard

Stop splitting code across coupled modules that are only included once

Open dylanahsmith opened this issue 4 years ago • 0 comments

Currently, IdentityCache::WithoutPrimaryIndex has the following single use internal module includes

    include IdentityCache::BelongsToCaching
    include IdentityCache::CacheKeyGeneration
    include IdentityCache::ConfigurationDSL
    include IdentityCache::QueryAPI
    include IdentityCache::CacheInvalidation
    include IdentityCache::ShouldUseCache
    include ParentModelExpiration

This is an anti-pattern that comes from not having proper separation of code into separate classes. To make things even worse, all this code is being included into model classes, so making any of the methods private doesn't actually prevent application code from calling them.

A better pattern to follow is the one taken by the classes in the IdentityCache::Cached namespace. They are built during initialization, which avoids adding extra object allocation on hot code paths, but still provides a place to store configuration state and methods that use that state. There may be more methods we can move into those classes and there may be opportunities to create new classes that are decoupled from the model classes.

The remaining methods on those single use internal module should be moved into IdentityCache::WithoutPrimaryIndex.

dylanahsmith avatar Jun 11 '21 20:06 dylanahsmith