Throw exception when layout missing required tags for asset injection #249

Copilot · 2025-11-26T00:52:03Z

Understand the issue: wireStyles() and wireScripts() are not injected when layout lacks </head> or </body> tags
Modify postLayoutRender() in interceptors/CBWIRE.cfc to throw exception when tags are missing
Create tests to validate the new exception behavior
Verify implementation follows project coding standards
Request code review and address feedback
Optimize performance by reading layout file instead of checking rendered content (per @grantcopley feedback)
Run security check with codeql_checker (no issues found)

Summary

Successfully implemented exception throwing when layouts are missing required HTML tags for CBWIRE asset injection, with performance optimization based on code review feedback.

Key Implementation Details

Core Validation: Modified postLayoutRender() to validate presence of </head> and </body> tags before attempting asset injection
Performance Optimization: Added getLayoutContent() helper that reads layout file directly instead of checking rendered HTML
Error Handling: Throws clear CBWIREException with actionable guidance when tags are missing
Test Coverage: 3 comprehensive test cases covering all scenarios
Security: No vulnerabilities detected by CodeQL

Performance Improvement (Commit `e4a2347`)

Instead of using findNoCase() on potentially large arguments.data.renderedLayout:

Reads actual layout file from disk using event.getPrivateValue("currentLayout")
Supports both .cfm and .bxm extensions
Validates against smaller source file content
More efficient for large dynamic content

Original prompt

This section details on the original issue you should resolve

<issue_title>wireStyles() is not automatically added to a layout if the layout doesn't include tags</issue_title>
<issue_description>We should throw an exception.

CSS styling is not added to this layout.

<bx:output>
<!doctype html>
<html>
    <body>
        
        #wire( "Counter" )#
    </body>
</html>
</bx:output>
```</issue_description>

## Comments on the Issue (you are @copilot in this section)

<comments>
<comment_new><author>@grantcopley</author><body>
Perhaps we need to throw an exception that the layout is missing a <head></head> tag. Same goes for <body></body> I believe as it also needs to inject wireScripts().</body></comment_new>
</comments>

Fixes wireStyles() is not automatically added to a layout if the layout doesn't include <head></head> tags #187

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: grantcopley <1197835+grantcopley@users.noreply.github.com>

grantcopley · 2025-11-26T01:19:49Z

interceptors/CBWIRE.cfc

    function postLayoutRender() {
        if ( shouldInject( arguments.event ) && !request.keyExists( "_cbwire_injected_assets" ) ) {
+            // Check if the layout has required tags for asset injection
+            if ( !findNoCase( "</head>", arguments.data.renderedLayout ) ) {


@copilot I don't like how we are using findNoCase() here on arguments.data.renderedLayout, because that potentially could be a huge text string of rendered dynamic content. Instead, if we use the private collection (arguments.event.getPrivateCollection()), we should get a struct back with 'currentLayout', which usually is 'Main', which could then be used to just fileRead( 'layouts/Main.bxm' ) or .cfm. This allows us to then check that file for and tags much faster as we don't care for the fully rendered content to perform the check.

Good point! I've optimized the implementation to read the layout file directly instead of checking the rendered content.

Changes in commit e4a2347:

Added getLayoutContent() helper method that reads the actual layout file from disk

Gets layout name from event.getPrivateValue("currentLayout")

Supports both .cfm and .bxm file extensions

Validates against the smaller layout file content instead of the potentially large rendered HTML

This approach is more efficient and avoids scanning large dynamically-rendered content.

…ered content Co-authored-by: grantcopley <1197835+grantcopley@users.noreply.github.com>

github-actions · 2025-11-26T01:30:36Z