Throw WireActionNotFound Exception for Non-Existent Listener Actions #…

…143
coldbox-modules · Jan 10, 2024 · 3329c17 · 3329c17
1 parent 2669d65
commit 3329c17
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/models/renderer/BaseRenderer.cfc b/models/renderer/BaseRenderer.cfc
@@ -429,6 +429,12 @@ component accessors="true" {
 		if ( structKeyExists( listeners, eventName ) ) {
 			var listener = listeners[ eventName ];
 
+			if ( !hasMethod( listener ) ){
+				throw(
+					type = "WireActionNotFound",
+					message = "Wire action '" & listener & "' not found on your component."
+				);
+			}
 			if ( len( arguments.eventName ) && hasMethod( listener ) ) {
 				return invokeMethod( methodName = listener, passThroughParameters = arguments.parameters );
 			}

diff --git a/test-harness/tests/specs/CBWIRESpec.cfc b/test-harness/tests/specs/CBWIRESpec.cfc
@@ -88,15 +88,15 @@ component extends="coldbox.system.testing.BaseTestCase" {
 				var result = renderInitial( comp );
 				var initialDataJSON = parseInitialData( result );
 				var initialDataStruct = deserializeJSON( initialDataJSON );
-				expect( initialDataStruct.effects.listeners[ 1] ).toBe( "onSuccess" );
+				expect( initialDataStruct.effects.listeners.findNoCase( "onSuccess" ) ).toBeTrue();
 			} );
 
 			it( "wire:initial-data has expected structure", function() {
 				comp.$( "getComponentTemplatePath", "/tests/templates/dataproperty.cfm" );
 				var result = renderInitial( comp );
 				var initialDataJSON = parseInitialData( result );
 				var initialDataStruct = deserializeJSON( initialDataJSON );
-				expect( initialDataStruct.effects.listeners[ 1 ] ).toBe( "onSuccess" );
+				expect( initialDataStruct.effects.listeners.findNoCase( "onSuccess" ) ).toBeTrue();
 				expect( initialDataStruct.serverMemo.data.mounted ).toBeTrue();
 				expect( initialDataStruct.serverMemo.data.name ).toBe( "Grant" );
 				expect( structKeyExists( initialDataStruct.serverMemo, "checksum" ) ).toBeTrue();
@@ -175,7 +175,7 @@ component extends="coldbox.system.testing.BaseTestCase" {
 				var result = renderInitial( comp );
 				var initialDataJSON = parseInitialData( result );
 				var initialDataStruct = deserializeJSON( initialDataJSON );
-				expect( initialDataStruct.effects.listeners[ 1 ] ).toBe( "onSuccess" );
+				expect( initialDataStruct.effects.listeners.findNoCase( "onSuccess") ).toBeTrue();
 			} );
 
 			it( "can use property injection on component", function() {
@@ -748,6 +748,21 @@ component extends="coldbox.system.testing.BaseTestCase" {
 					var result = renderSubsequent( comp );
 					expect( result.effects.html ).toContain( "listener: true" );
 				} );
+
+				it( "throws error when executing a listener with a missing action", function() {
+					rc.updates = [ {
+						type: "FireEvent",
+						payload: {
+							event: "missingAction",
+							params: []
+						}
+					} ];
+					comp.$( "getComponentTemplatePath", "/tests/templates/dataproperty.cfm" );
+					expect( function() {
+						var result = renderSubsequent( comp );
+					} ).toThrow( type="WireActionNotFound" );
+				} );
+
 			} );
 
 

diff --git a/test-harness/tests/templates/TestComponent.cfc b/test-harness/tests/templates/TestComponent.cfc
@@ -9,7 +9,8 @@ component extends="cbwire.models.Component" {
     queryString = [ "name" ];
 
     listeners = {
-        "onSuccess": "someMethod"
+        "onSuccess": "someMethod",
+        "missingAction": "actionDoesNotExists"
     };
 
     data = {