Side effect

Author: oklemenz2

CHANGELOG.md

@@ -5,10 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## Version 1.9.2 - 2025-12-xx
+## Version 1.9.2 - 2025-12-01
 
 ### Fixed
 
+- Fix side effect event name and source properties
 - Queue/outbox websocket services automatically when configured accordingly in `cds.requires`
 - Document how to handle websocket paths in different scenarios
 

README.md

@@ -1208,15 +1208,15 @@ Example:
 @ws.pcp.sideEffect
 @ws.pcp.channel: 'amc\://notification/notify'
 event sideEffect {
-    sideEffectsSource: String;
+    sideEffectSource: String;
 }
 ```
 
 Emitting the event `sideEffect` via CDS emit, as follows:
 
 ```js
 await srv.emit("sideEffect", {
-  sideEffectsSource: "/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')",
+  sideEffectSource: "/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')",
 });
 ```
 
@@ -1225,8 +1225,8 @@ It results in the following PCP message sent via websocket protocol:
 ```
 pcp-action:MESSAGE
 pcp-channel:amc:\:notification/notify
-sideEffectsSource:/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')
-sideEffectsEventName:sideEffect
+sideEffectSource:/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')
+sideEffectEventName:sideEffect
 serverAction:RaiseSideEffect
 
 

src/format/pcp.js

@@ -117,8 +117,8 @@ class PCPFormat extends GenericFormat {
     }
     if (pcpSideEffect) {
       pcpFieldsFiltered = {
-        sideEffectsSource: "",
-        sideEffectsEventName: pcpEvent,
+        sideEffectSource: "",
+        sideEffectEventName: pcpEvent,
         serverAction: "RaiseSideEffect",
         ...pcpFieldsFiltered,
       };

test/_env/srv/handlers/pcp.js

@@ -54,7 +54,7 @@ module.exports = (srv) => {
 
   srv.on("triggerSideEffects", async () => {
     await srv.emit("sideEffect1", {
-      sideEffectsSource: "/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')",
+      sideEffectSource: "/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')",
     });
     return true;
   });

test/_env/srv/pcp.cds

@@ -53,6 +53,6 @@ service PCPService {
     @ws.pcp.event: 'sideEffect1'
     @ws.pcp.channel: 'amc\://notification/notify'
     event sideEffect1 {
-        sideEffectsSource: String;
+        sideEffectSource: String;
     }
 }

test/socketio/pcp_socket.io.test.js

@@ -71,8 +71,8 @@ const pcpTriggerSideEffects = `pcp-action:triggerSideEffects
 
 const pcpSideEffect1 = `pcp-action:MESSAGE
 pcp-channel:amc\\://notification/notify
-sideEffectsSource:/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')
-sideEffectsEventName:sideEffect1
+sideEffectSource:/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')
+sideEffectEventName:sideEffect1
 serverAction:RaiseSideEffect
 
 `;

test/ws/pcp_ws.test.js

@@ -68,8 +68,8 @@ const pcpTriggerSideEffects = `pcp-action:triggerSideEffects
 
 const pcpSideEffect1 = `pcp-action:MESSAGE
 pcp-channel:amc\\://notification/notify
-sideEffectsSource:/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')
-sideEffectsEventName:sideEffect1
+sideEffectSource:/Header(ID='e0582b6a-6d93-46d9-bd28-98723a285d40')
+sideEffectEventName:sideEffect1
 serverAction:RaiseSideEffect
 
 `;