Skip to content

feat(renderer): add viewDiscoveryCaching setting and optimize hot paths #664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lmajano merged 1 commit into from
Jun 19, 2026
+146 −41
Merged

feat(renderer): add viewDiscoveryCaching setting and optimize hot paths #664

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
132 changes: 91 additions & 41 deletions system/web/Renderer.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,25 @@ component
property name="lockName";
// Discovery caching is tied to handlers for discovery.
property name="isDiscoveryCaching";
// Memoized expandPath() results — always active, expandPath is pure
property name="expandPathCache";
// Cached results of locateView() calls
property name="locateViewCache";
// Cached results of locateLayout() calls
property name="locateLayoutCache";

/**
* Constructor
*/
function init(){
// Layouts + Views Reference Maps
variables.layoutsRefMap = {};
variables.viewsRefMap = {};
variables.layoutsRefMap = {};
variables.viewsRefMap = {};
// expandPath() is deterministic — cache unconditionally
variables.expandPathCache = {};
// Per-name locate caches, gated by viewDiscoveryCaching
variables.locateViewCache = {};
variables.locateLayoutCache = {};
super.init();
return this;
}
Expand Down Expand Up @@ -106,8 +117,8 @@ component
// Template Cache & Caching Maps
variables.lockName = "rendering.#variables.controller.getAppHash()#";

// Discovery caching
variables.isDiscoveryCaching = variables.controller.getSetting( "viewCaching" );
// Discovery caching — independent from viewCaching (output cache)
variables.isDiscoveryCaching = variables.controller.getSetting( "viewDiscoveryCaching" );

// Load Application helpers
loadApplicationHelpers();
Expand Down Expand Up @@ -645,6 +656,11 @@ component
// Remove extension: We need to test cfm vs bxm
arguments.layout = reReplace( arguments.layout, "\.(cfm|bxm)$", "", "one" );

// Return cached result when discovery caching is active
if ( variables.isDiscoveryCaching && variables.locateLayoutCache.keyExists( arguments.layout ) ) {
return variables.locateLayoutCache[ arguments.layout ];
}

// Default path is the conventions location
var layoutPaths = [
// Conventions location first
Expand All @@ -657,18 +673,27 @@ component
"#arguments.layout#"
];

// Try to locate the view
// Try to locate the layout
for ( var thisLayoutPath in layoutPaths ) {
thisLayoutPath = reReplace( thisLayoutPath, "//", "/", "all" );
if ( fileExists( expandPath( thisLayoutPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( thisLayoutPath & ".cfm" ) ) ) {
if ( variables.isDiscoveryCaching && !variables.locateLayoutCache.keyExists( arguments.layout ) ) {
variables.locateLayoutCache[ arguments.layout ] = thisLayoutPath & ".cfm";
}
return thisLayoutPath & ".cfm";
}
if ( fileExists( expandPath( thisLayoutPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( thisLayoutPath & ".bxm" ) ) ) {
if ( variables.isDiscoveryCaching && !variables.locateLayoutCache.keyExists( arguments.layout ) ) {
variables.locateLayoutCache[ arguments.layout ] = thisLayoutPath & ".bxm";
}
return thisLayoutPath & ".bxm";
}
}

// If all fails, return the path as is
if ( variables.isDiscoveryCaching && !variables.locateLayoutCache.keyExists( arguments.layout ) ) {
variables.locateLayoutCache[ arguments.layout ] = arguments.layout;
}
return arguments.layout;
}

Expand All @@ -692,10 +717,10 @@ component
// Explicit Module layout lookup?
if ( len( arguments.module ) and arguments.explicitModule ) {
var explicitLayout = "#variables.modulesConfig[ arguments.module ].mapping#/#variables.modulesConfig[ arguments.module ].conventions.layoutsLocation#/#arguments.layout#";
if ( fileExists( expandPath( explicitLayout & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( explicitLayout & ".cfm" ) ) ) {
return explicitLayout & ".cfm";
}
if ( fileExists( expandPath( explicitLayout & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( explicitLayout & ".bxm" ) ) ) {
return explicitLayout & ".bxm";
}
throw(
Expand Down Expand Up @@ -724,26 +749,26 @@ component
// Check parent view order setup
if ( variables.modulesConfig[ moduleName ].layoutParentLookup ) {
// We check if layout is overridden in parent first.
if ( fileExists( expandPath( parentModuleLayoutPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( parentModuleLayoutPath & ".cfm" ) ) ) {
return parentModuleLayoutPath & ".cfm";
}
if ( fileExists( expandPath( parentModuleLayoutPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( parentModuleLayoutPath & ".bxm" ) ) ) {
return parentModuleLayoutPath & ".bxm";
}

// Check if parent has a common layout override
if ( fileExists( expandPath( parentCommonLayoutPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( parentCommonLayoutPath & ".cfm" ) ) ) {
return parentCommonLayoutPath & ".cfm";
}
if ( fileExists( expandPath( parentCommonLayoutPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( parentCommonLayoutPath & ".bxm" ) ) ) {
return parentCommonLayoutPath & ".bxm";
}

// Check module
if ( fileExists( expandPath( moduleLayoutPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( moduleLayoutPath & ".cfm" ) ) ) {
return moduleLayoutPath & ".cfm";
}
if ( fileExists( expandPath( moduleLayoutPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( moduleLayoutPath & ".bxm" ) ) ) {
return moduleLayoutPath & ".bxm";
}

Expand All @@ -752,26 +777,26 @@ component
}

// If we reach here then we are doing module lookup first then if not parent.
if ( fileExists( expandPath( moduleLayoutPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( moduleLayoutPath & ".cfm" ) ) ) {
return moduleLayoutPath & ".cfm";
}
if ( fileExists( expandPath( moduleLayoutPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( moduleLayoutPath & ".bxm" ) ) ) {
return moduleLayoutPath & ".bxm";
}

// We check if layout is overridden in parent first.
if ( fileExists( expandPath( parentModuleLayoutPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( parentModuleLayoutPath & ".cfm" ) ) ) {
return parentModuleLayoutPath & ".cfm";
}
if ( fileExists( expandPath( parentModuleLayoutPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( parentModuleLayoutPath & ".bxm" ) ) ) {
return parentModuleLayoutPath & ".bxm";
}

// Check if parent has a common layout override
if ( fileExists( expandPath( parentCommonLayoutPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( parentCommonLayoutPath & ".cfm" ) ) ) {
return parentCommonLayoutPath & ".cfm";
}
if ( fileExists( expandPath( parentCommonLayoutPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( parentCommonLayoutPath & ".bxm" ) ) ) {
return parentCommonLayoutPath & ".bxm";
}

Expand All @@ -788,6 +813,11 @@ component
// Remove extension: We need to test cfm vs bxm
arguments.view = reReplace( arguments.view, "\.(cfm|bxm)$", "", "one" );

// Return cached result when discovery caching is active
if ( variables.isDiscoveryCaching && variables.locateViewCache.keyExists( arguments.view ) ) {
return variables.locateViewCache[ arguments.view ];
}

// Default path is the conventions location, then the external location
var viewPaths = [
// Conventions location first
Expand All @@ -803,15 +833,24 @@ component
// Try to locate the view
for ( var thisViewPath in viewPaths ) {
thisViewPath = reReplace( thisViewPath, "//", "/", "all" );
if ( fileExists( expandPath( thisViewPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( thisViewPath & ".cfm" ) ) ) {
if ( variables.isDiscoveryCaching && !variables.locateViewCache.keyExists( arguments.view ) ) {
variables.locateViewCache[ arguments.view ] = thisViewPath & ".cfm";
}
return thisViewPath & ".cfm";
}
if ( fileExists( expandPath( thisViewPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( thisViewPath & ".bxm" ) ) ) {
if ( variables.isDiscoveryCaching && !variables.locateViewCache.keyExists( arguments.view ) ) {
variables.locateViewCache[ arguments.view ] = thisViewPath & ".bxm";
}
return thisViewPath & ".bxm";
}
}

// If all fails, return the path as is
if ( variables.isDiscoveryCaching && !variables.locateViewCache.keyExists( arguments.view ) ) {
variables.locateViewCache[ arguments.view ] = arguments.view;
}
return arguments.view;
}

Expand All @@ -833,10 +872,10 @@ component
// Explicit Module view lookup?
if ( len( arguments.module ) and arguments.explicitModule ) {
var explicitView = "#variables.modulesConfig[ arguments.module ].mapping#/#variables.modulesConfig[ arguments.module ].conventions.viewsLocation#/#arguments.view#";
if ( fileExists( expandPath( explicitView & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( explicitView & ".cfm" ) ) ) {
return explicitView & ".cfm";
}
if ( fileExists( expandPath( explicitView & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( explicitView & ".bxm" ) ) ) {
return explicitView & ".bxm";
}
throw(
Expand Down Expand Up @@ -865,26 +904,26 @@ component
// Check parent view order setup
if ( variables.modulesConfig[ moduleName ].viewParentLookup ) {
// We check if view is overridden in parent first.
if ( fileExists( expandPath( parentModuleViewPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( parentModuleViewPath & ".cfm" ) ) ) {
return parentModuleViewPath & ".cfm";
}
if ( fileExists( expandPath( parentModuleViewPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( parentModuleViewPath & ".bxm" ) ) ) {
return parentModuleViewPath & ".bxm";
}

// Check if parent has a common view override
if ( fileExists( expandPath( parentCommonViewPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( parentCommonViewPath & ".cfm" ) ) ) {
return parentCommonViewPath & ".cfm";
}
if ( fileExists( expandPath( parentCommonViewPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( parentCommonViewPath & ".bxm" ) ) ) {
return parentCommonViewPath & ".bxm";
}

// Check module for view
if ( fileExists( expandPath( moduleViewPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( moduleViewPath & ".cfm" ) ) ) {
return moduleViewPath & ".cfm";
}
if ( fileExists( expandPath( moduleViewPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( moduleViewPath & ".bxm" ) ) ) {
return moduleViewPath & ".bxm";
}

Expand All @@ -893,26 +932,26 @@ component
}

// If we reach here then we are doing module lookup first then if not the parent.
if ( fileExists( expandPath( moduleViewPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( moduleViewPath & ".cfm" ) ) ) {
return moduleViewPath & ".cfm";
}
if ( fileExists( expandPath( moduleViewPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( moduleViewPath & ".bxm" ) ) ) {
return moduleViewPath & ".bxm";
}

// We check if view is overridden in parent first.
if ( fileExists( expandPath( parentModuleViewPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( parentModuleViewPath & ".cfm" ) ) ) {
return parentModuleViewPath & ".cfm";
}
if ( fileExists( expandPath( parentModuleViewPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( parentModuleViewPath & ".bxm" ) ) ) {
return parentModuleViewPath & ".bxm";
}

// Check if parent has a common view override
if ( fileExists( expandPath( parentCommonViewPath & ".cfm" ) ) ) {
if ( fileExists( cachedExpandPath( parentCommonViewPath & ".cfm" ) ) ) {
return parentCommonViewPath & ".cfm";
}
if ( fileExists( expandPath( parentCommonViewPath & ".bxm" ) ) ) {
if ( fileExists( cachedExpandPath( parentCommonViewPath & ".bxm" ) ) ) {
return parentCommonViewPath & ".bxm";
}

Expand Down Expand Up @@ -964,19 +1003,19 @@ component

// Check for directory helper convention first
var dPath = getDirectoryFromPath( results.viewPath );
if ( fileExists( expandPath( dPath & listLast( dPath, "\/" ) & "Helper.cfm" ) ) ) {
if ( fileExists( cachedExpandPath( dPath & listLast( dPath, "\/" ) & "Helper.cfm" ) ) ) {
results.viewHelperPath.append( dPath & listLast( dPath, "\/" ) & "Helper.cfm" );
}
if ( fileExists( expandPath( dPath & listLast( dPath, "\/" ) & "Helper.bxm" ) ) ) {
if ( fileExists( cachedExpandPath( dPath & listLast( dPath, "\/" ) & "Helper.bxm" ) ) ) {
results.viewHelperPath.append( dPath & listLast( dPath, "\/" ) & "Helper.bxm" );
}

// Check for view helper convention second
var vPath = results.viewPath.listFirst( "." );
if ( fileExists( expandPath( vPath & "Helper.cfm" ) ) ) {
if ( fileExists( cachedExpandPath( vPath & "Helper.cfm" ) ) ) {
results.viewHelperPath.append( vPath & "Helper.cfm" );
}
if ( fileExists( expandPath( vPath & "Helper.bxm" ) ) ) {
if ( fileExists( cachedExpandPath( vPath & "Helper.bxm" ) ) ) {
results.viewHelperPath.append( vPath & "Helper.bxm" );
}

Expand All @@ -990,6 +1029,17 @@ component

/************************************** PRIVATE *********************************************/

/**
* Memoized expandPath() — the mapping-to-absolute-path computation is pure and
* never changes between requests, so we cache it unconditionally.
*/
private function cachedExpandPath( required string path ){
if ( !variables.expandPathCache.keyExists( arguments.path ) ) {
variables.expandPathCache[ arguments.path ] = expandPath( arguments.path );
}
return variables.expandPathCache[ arguments.path ];
}

/**
* Verifies if we should render the implicit view or not
*/
Expand Down
1 change: 1 addition & 0 deletions system/web/config/Settings.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ component {
"handlerCaching" : true,
"eventCaching" : true,
"viewCaching" : true,
"viewDiscoveryCaching" : true,
// Default Conventions Events + Views
"defaultEvent" : "main.index",
"defaultLayout" : "Main",
Expand Down
54 changes: 54 additions & 0 deletions tests/specs/web/RendererTest.cfc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,60 @@ component extends="tests.resources.BaseIntegrationTest" {
} );


describe( "Discovery Cache", function(){
it( "viewDiscoveryCaching setting defaults to true", function(){
expect( getController().getSetting( "viewDiscoveryCaching" ) ).toBeTrue();
} );

it( "locateView caches path results when viewDiscoveryCaching is true", function(){
renderer.$property( "locateViewCache", "variables", {} );
renderer.$property( "isDiscoveryCaching", "variables", true );
var path1 = renderer.locateView( "simpleview" );
var path2 = renderer.locateView( "simpleview" );
expect( path1 ).toBe( path2 );
expect( path1 ).toInclude( "simpleview" );
expect( structCount( renderer.getLocateViewCache() ) ).toBeGT( 0 );
} );

it( "locateLayout caches path results when viewDiscoveryCaching is true", function(){
renderer.$property( "locateLayoutCache", "variables", {} );
renderer.$property( "isDiscoveryCaching", "variables", true );
var path1 = renderer.locateLayout( "Main" );
var path2 = renderer.locateLayout( "Main" );
expect( path1 ).toBe( path2 );
expect( path1 ).toInclude( "Main" );
expect( structCount( renderer.getLocateLayoutCache() ) ).toBeGT( 0 );
} );

it( "expandPathCache is always populated regardless of viewDiscoveryCaching", function(){
renderer.$property( "expandPathCache", "variables", {} );
renderer.$property( "isDiscoveryCaching", "variables", false );
renderer.locateView( "simpleview" );
expect( structCount( renderer.getExpandPathCache() ) ).toBeGT( 0 );
} );

it( "does not populate locateViewCache when viewDiscoveryCaching is false", function(){
renderer.$property( "isDiscoveryCaching", "variables", false );
renderer.$property( "locateViewCache", "variables", {} );
renderer.locateView( "simpleview" );
expect( structCount( renderer.getLocateViewCache() ) ).toBe( 0 );
} );

it( "does not populate locateLayoutCache when viewDiscoveryCaching is false", function(){
renderer.$property( "isDiscoveryCaching", "variables", false );
renderer.$property( "locateLayoutCache", "variables", {} );
renderer.locateLayout( "Main" );
expect( structCount( renderer.getLocateLayoutCache() ) ).toBe( 0 );
} );

it( "discoverViewPaths populates viewsRefMap when viewDiscoveryCaching is true", function(){
renderer.$property( "viewsRefMap", "variables", {} );
renderer.$property( "isDiscoveryCaching", "variables", true );
renderer.discoverViewPaths( view : "simpleview", module : "", explicitModule : false );
expect( structCount( renderer.$getProperty( "viewsRefMap", "variables" ) ) ).toBeGT( 0 );
} );
} );

feature( "ColdBox can render view collections", function(){
beforeEach( function( currentSpec ){
aUsers = [
Expand Down
Loading