Merge pull request #492 from evo-lua/etrace-notify-fix

Prevent event notifications from being suppressed if logging for the given event happens to be disabled

Runtime/Libraries/etrace.lua

@@ -287,11 +287,6 @@ function etrace.notify(event, payload)
 		return
 	end
 
-	local isEventEnabled = (etrace.registeredEvents[event] == true)
-	if not isEventEnabled then
-		return
-	end
-
 	for listener, eventHandler in pairs(subscribers) do
 		if type(listener) == "table" then -- Enable use of : syntax
 			eventHandler(listener, event, payload)

Tests/BDD/etrace-library.spec.lua

@@ -715,17 +715,19 @@ describe("etrace", function()
 			assertEquals(providedArguments.functionListener, { "MEEP", {} })
 		end)
 
-		it("should have no effect if the given event is disabled", function()
+		it("should still work if logging for the given event is disabled", function()
 			local providedArguments = {}
 
 			local function functionListener(event, payload)
 				providedArguments.functionListener = { event, payload }
 			end
 
 			etrace.register("MEEP")
+			etrace.disable("MEEP")
 			etrace.subscribe("MEEP", functionListener)
 			etrace.notify("MEEP", { hello = 42 })
-			assertEquals(providedArguments.functionListener, nil)
+			assertEquals(providedArguments.functionListener[1], "MEEP")
+			assertEquals(providedArguments.functionListener[2].hello, 42)
 		end)
 	end)
 
@@ -777,7 +779,7 @@ describe("etrace", function()
 			assertEquals(providedArguments.functionListener, { "MEEP", { hello = 42 } })
 		end)
 
-		it("should have no effect if the given event is disabled", function()
+		it("should still work if logging for the given event is disabled", function()
 			local providedArguments = {}
 
 			local function functionListener(event, payload)
@@ -787,7 +789,11 @@ describe("etrace", function()
 			etrace.register("MEEP")
 			etrace.subscribe("MEEP", functionListener)
 			etrace.publish("MEEP", { hello = 42 })
-			assertEquals(providedArguments.functionListener, nil)
+			-- Disabling event notifications would break any listener relying on the event system
+			assertEquals(providedArguments.functionListener[1], "MEEP")
+			assertEquals(providedArguments.functionListener[2].hello, 42)
+
+			-- The log should be empty, however as logging was indeed disabled
 			assertEquals(etrace.filter(), {})
 		end)
 	end)