Skip to content

Commit

Permalink
Sketching out the idea of the sobject cache
Browse files Browse the repository at this point in the history
  • Loading branch information
@rob-baillie-ortoo
rob-baillie-ortoo committed Mar 8, 2022
1 parent 3f1ea97 commit 6a6ba9f
Show file tree
Hide file tree
Showing 14 changed files with 256 additions and 142 deletions.
144 changes: 2 additions & 142 deletions ...es/fflib-extension/CachedSoqlExecutor.cls → ...-extension/caching/CachedSoqlExecutor.cls
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ public inherited sharing class CachedSoqlExecutor //NOPMD: incorrect report of t
{
public class CacheAccessViolationException extends Exceptions.DeveloperException {} // this looks like a config exception, but actually the system should be built
// in such a way that it's never possible to get this exception
public enum CacheScope { NONE, ORG, SESSION }

CacheWrapper cacheWrapper = new OrgCache(); // by default, configure the cache to use the org version
ICacheAdaptor cacheWrapper = new OrgCache(); // by default, configure the cache to use the org version

private final static String SOQL_PARTITION_NAME = 'soql';
private final static Integer CACHE_LIFESPAN_SECONDS = 28800; // TODO: soft setting / option
Expand All @@ -32,8 +33,6 @@ public inherited sharing class CachedSoqlExecutor //NOPMD: incorrect report of t
set;
}

public enum CacheScope { NONE, ORG, SESSION }

public CachedSoqlExecutor setScope( CacheScope scope )
{
Contract.requires( scope != null, 'setScope called with a null scope' );
Expand Down Expand Up @@ -172,143 +171,4 @@ public inherited sharing class CachedSoqlExecutor //NOPMD: incorrect report of t
{
return cacheWrapper.createFullyQualifiedKey( PackageUtils.NAMESPACE_PREFIX, SOQL_PARTITION_NAME, subkey );
}

private interface CacheWrapper
{
Boolean isACache();
Object get( String key );
void put( String key, Object value, Integer lifespan );
Set<String> getKeys();
Boolean contains( String key );
void remove( String key );
String createFullyQualifiedPartitionName( String namespace, String partitionName );
String createFullyQualifiedKey( String namespace, String partitionName, String subKey );
}

private class OrgCache implements CacheWrapper
{
public Boolean isACache()
{
return true;
}

public Object get( String key )
{
return Cache.Org.get( key );
}

public void put( String key, Object value, Integer lifespan )
{
Cache.Org.put( key, value, lifespan, Cache.Visibility.NAMESPACE, true ); // immutable results
}

public Set<String> getKeys()
{
return Cache.Org.getKeys();
}

public Boolean contains( String key )
{
return Cache.Org.contains( key );
}

public void remove( String key )
{
Cache.Org.remove( key );
}

public String createFullyQualifiedPartitionName( String namespace, String partitionName )
{
return Cache.OrgPartition.createFullyQualifiedPartition( namespace, partitionName );
}

public String createFullyQualifiedKey( String namespace, String partitionName, String subKey )
{
return Cache.OrgPartition.createFullyQualifiedKey( PackageUtils.NAMESPACE_PREFIX, SOQL_PARTITION_NAME, subkey );
}
}

private class SessionCache implements CacheWrapper
{
public Boolean isACache()
{
return true;
}

public Object get( String key )
{
return Cache.Session.get( key );
}

public void put( String key, Object value, Integer lifespan )
{
Cache.Session.put( key, value, lifespan, Cache.Visibility.NAMESPACE, true ); // immutable results
}

public Set<String> getKeys()
{
return Cache.Session.getKeys();
}

public Boolean contains( String key )
{
return Cache.Session.contains( key );
}

public void remove( String key )
{
Cache.Session.remove( key );
}

public String createFullyQualifiedPartitionName( String namespace, String partitionName )
{
return Cache.SessionPartition.createFullyQualifiedPartition( namespace, partitionName );
}

public String createFullyQualifiedKey( String namespace, String partitionName, String subKey )
{
return Cache.SessionPartition.createFullyQualifiedKey( PackageUtils.NAMESPACE_PREFIX, SOQL_PARTITION_NAME, subkey );
}
}

private class NullCache implements CacheWrapper
{
public Boolean isACache()
{
return false;
}

public Object get( String key )
{
return null;
}

public void put( String key, Object value, Integer lifespan ) // NOPMD: Intentionally left empty, as this should do nothing in a NullCache
{
}

public Set<String> getKeys()
{
return new Set<String>();
}

public Boolean contains( String key )
{
return false;
}

public void remove( String key ) // NOPMD: Intentionally left empty, as this should do nothing in a NullCache
{
}

public String createFullyQualifiedPartitionName( String namespace, String partitionName )
{
return namespace + '.' + partitionName;
}

public String createFullyQualifiedKey( String namespace, String partitionName, String subKey )
{
return namespace + '.' + partitionName + '.' + subkey;
}
}
}
0 ...extension/CachedSoqlExecutor.cls-meta.xml → ...n/caching/CachedSoqlExecutor.cls-meta.xml
View file
File renamed without changes.
11 changes: 11 additions & 0 deletions framework/default/ortoo-core/default/classes/fflib-extension/caching/ICacheAdaptor.cls
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
public interface ICacheAdaptor
{
Boolean isACache();
Object get( String key );
void put( String key, Object value, Integer lifespan );
Set<String> getKeys();
Boolean contains( String key );
void remove( String key );
String createFullyQualifiedPartitionName( String namespace, String partitionName );
String createFullyQualifiedKey( String namespace, String partitionName, String subKey );
}
0 ...tests/CachedSoqlExecutorTest.cls-meta.xml → ...ension/caching/ICacheAdaptor.cls-meta.xml
View file
File renamed without changes.
40 changes: 40 additions & 0 deletions framework/default/ortoo-core/default/classes/fflib-extension/caching/NullCache.cls
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
public class NullCache implements ICacheAdaptor
{
public Boolean isACache()
{
return false;
}

public Object get( String key )
{
return null;
}

public void put( String key, Object value, Integer lifespan ) // NOPMD: Intentionally left empty, as this should do nothing in a NullCache
{
}

public Set<String> getKeys()
{
return new Set<String>();
}

public Boolean contains( String key )
{
return false;
}

public void remove( String key ) // NOPMD: Intentionally left empty, as this should do nothing in a NullCache
{
}

public String createFullyQualifiedPartitionName( String namespace, String partitionName )
{
return namespace + '.' + partitionName;
}

public String createFullyQualifiedKey( String namespace, String partitionName, String subKey )
{
return namespace + '.' + partitionName + '.' + subkey;
}
}
5 changes: 5 additions & 0 deletions framework/default/ortoo-core/default/classes/fflib-extension/caching/NullCache.cls-meta.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>52.0</apiVersion>
<status>Active</status>
</ApexClass>
42 changes: 42 additions & 0 deletions framework/default/ortoo-core/default/classes/fflib-extension/caching/OrgCache.cls
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
public class OrgCache implements ICacheAdaptor
{
public Boolean isACache()
{
return true;
}

public Object get( String key )
{
return Cache.Org.get( key );
}

public void put( String key, Object value, Integer lifespan )
{
Cache.Org.put( key, value, lifespan, Cache.Visibility.NAMESPACE, true ); // immutable outside of namespace
}

public Set<String> getKeys()
{
return Cache.Org.getKeys();
}

public Boolean contains( String key )
{
return Cache.Org.contains( key );
}

public void remove( String key )
{
Cache.Org.remove( key );
}

public String createFullyQualifiedPartitionName( String namespace, String partitionName )
{
return Cache.OrgPartition.createFullyQualifiedPartition( namespace, partitionName );
}

public String createFullyQualifiedKey( String namespace, String partitionName, String subKey )
{
return Cache.OrgPartition.createFullyQualifiedKey( namespace, partitionName, subkey );
}
}
5 changes: 5 additions & 0 deletions framework/default/ortoo-core/default/classes/fflib-extension/caching/OrgCache.cls-meta.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>52.0</apiVersion>
<status>Active</status>
</ApexClass>
42 changes: 42 additions & 0 deletions framework/default/ortoo-core/default/classes/fflib-extension/caching/SessionCache.cls
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
public class SessionCache implements ICacheAdaptor
{
public Boolean isACache()
{
return true;
}

public Object get( String key )
{
return Cache.Session.get( key );
}

public void put( String key, Object value, Integer lifespan )
{
Cache.Session.put( key, value, lifespan, Cache.Visibility.NAMESPACE, true ); // immutable outside of namespace
}

public Set<String> getKeys()
{
return Cache.Session.getKeys();
}

public Boolean contains( String key )
{
return Cache.Session.contains( key );
}

public void remove( String key )
{
Cache.Session.remove( key );
}

public String createFullyQualifiedPartitionName( String namespace, String partitionName )
{
return Cache.SessionPartition.createFullyQualifiedPartition( namespace, partitionName );
}

public String createFullyQualifiedKey( String namespace, String partitionName, String subKey )
{
return Cache.SessionPartition.createFullyQualifiedKey( namespace, partitionName, subkey );
}
}
5 changes: 5 additions & 0 deletions ...work/default/ortoo-core/default/classes/fflib-extension/caching/SessionCache.cls-meta.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
<apiVersion>52.0</apiVersion>
<status>Active</status>
</ApexClass>
Loading

0 comments on commit 6a6ba9f

Please sign in to comment.