[FSMCPB-165194]: Add Shell SDK tracing (#185)

Author: zalincaclaudiu

.github/workflows/fsh-shell_pull-request.yml

@@ -22,7 +22,8 @@ jobs:
           missing_files=""
           for i in "${array[@]}"
           do
-            [[ ${FILES_CHANGED[*]} =~ $i ]] && echo "$i file found in the changeset" || missing_files="$missing_files $i"
+            i_lower=$(echo "$i" | tr '[:upper:]' '[:lower:]')
+            [[ ${FILES_CHANGED[*]} =~ $i_lower ]] && echo "$i file found in the changeset" || missing_files="$missing_files $i"
           done
           echo ""
           [ -z "$missing_files" ] && echo "All mandatory files have been modified" || echo "Following files $missing_files have not been modified"

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.24.0] - 2026-03-23
+
+### Added
+
+- Add `trace` tracking to SDK messages for debugging and analytics
+- Added `TraceEntry` interface for the tracing information model
+
 ## [1.23.0] - 2026-03-13
 
 ### Added

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "fsm-shell",
-  "version": "1.23.0",
+  "version": "1.24.0",
   "description": "client library for FSM shell",
   "main": "release/fsm-shell-client.js",
   "module": "release/fsm-shell-client.es.js",

package.json

@@ -1,7 +1,7 @@
-
 import { EventType, ALL_SHELL_EVENTS_ARRAY } from './ShellEvents';
 import { EventDirection, DebugEvent } from './models/debug/debug-event';
 import { MessageLogger } from './MessageLogger';
+import { TraceEntry } from './models/trace/trace-entry.model';
 
 interface DebuggableWindow extends Window {
   fsmShellMessageLogger: MessageLogger | undefined;
@@ -10,29 +10,35 @@ interface DebuggableWindow extends Window {
 interface Routing {
   to?: string[];
   from?: string[];
+  trace?: TraceEntry[];
 }
 
 const FSM_SHELL_DEBUG_KEY = 'cs.fsm-shell.debug';
 
 export class Debugger {
-
   private debugMode: boolean = false;
 
-  constructor(
-    private winRef: Window,
-    private debugId: string
-  ) {
+  constructor(private winRef: Window, private debugId: string) {
     if (this.debugId) {
       const win = this.winRef as DebuggableWindow;
       const localStorageValue = win.localStorage.getItem(FSM_SHELL_DEBUG_KEY);
-      if (!!localStorageValue && localStorageValue.split(',').some(it => it === debugId)) {
+      if (
+        !!localStorageValue &&
+        localStorageValue.split(',').some((it) => it === debugId)
+      ) {
         this.debugMode = true;
       }
     }
   }
 
-  public traceEvent(direction: EventDirection, type: EventType, payload: any, routing: Routing, hasHandler: boolean) {
-    if (this.debugMode && ALL_SHELL_EVENTS_ARRAY.some(it => it === type)) {
+  public traceEvent(
+    direction: EventDirection,
+    type: EventType,
+    payload: any,
+    routing: Routing,
+    hasHandler: boolean
+  ) {
+    if (this.debugMode && ALL_SHELL_EVENTS_ARRAY.some((it) => it === type)) {
       const debugEvent: DebugEvent<any> = {
         timestamp: new Date(),
         component: this.debugId,
@@ -41,8 +47,9 @@ export class Debugger {
         handled: direction === 'incoming' ? (hasHandler ? 'yes' : 'no') : 'n/a',
         to: routing.to,
         from: routing.from,
-        payload
-      }
+        trace: routing.trace,
+        payload,
+      };
       this.logEvent(debugEvent);
     }
   }
@@ -54,5 +61,4 @@ export class Debugger {
     }
     win.fsmShellMessageLogger.push(debugEvent, this.debugId);
   }
-
 }