Change event details order to enhance discovery (#955)

* Change event details order to enhance discovery

* unify string default value and change unimportant to unneeded

* update snapshot

Author: Assem-Uber

src/utils/data-formatters/format-pending-workflow-history-event/__tests__/index.test.ts.snapshot

@@ -16,7 +16,7 @@ exports[`formatWorkflowHistoryEvent should format workflow pendingActivityTaskSt
     "workflow.sanity",
   ],
   "lastFailureDetails": null,
-  "lastFailureReason": "",
+  "lastFailureReason": null,
   "lastHeartbeatTime": null,
   "lastStartedTime": null,
   "lastWorkerIdentity": "",
@@ -44,7 +44,7 @@ exports[`formatWorkflowHistoryEvent should format workflow pendingActivityTaskSt
     "workflow.sanity",
   ],
   "lastFailureDetails": null,
-  "lastFailureReason": "",
+  "lastFailureReason": null,
   "lastHeartbeatTime": null,
   "lastStartedTime": 2024-09-07T22:16:10.599Z,
   "lastWorkerIdentity": "",
@@ -72,7 +72,7 @@ exports[`formatWorkflowHistoryEvent should format workflow pendingActivityTaskSt
     "workflow.sanity",
   ],
   "lastFailureDetails": null,
-  "lastFailureReason": "",
+  "lastFailureReason": null,
   "lastHeartbeatTime": null,
   "lastStartedTime": 2024-09-07T22:16:10.599Z,
   "lastWorkerIdentity": "",

src/utils/data-formatters/format-pending-workflow-history-event/format-pending-activity-start-event.ts

@@ -20,17 +20,17 @@ export default function formatPendingActivityTaskStartEvent({
   eventTime,
 }: PendingActivityTaskStartEvent) {
   return {
-    ...eventAttributes,
     eventTime: formatTimestampToDatetime(eventTime),
     eventType: 'PendingActivityTaskStart',
+    ...eventAttributes,
     state: formatEnum(state, 'PENDING_ACTIVITY_STATE', 'pascal'),
-    scheduleId: parseInt(scheduleId),
+    lastFailureDetails: formatFailureDetails(lastFailure),
+    lastFailureReason: lastFailure?.reason || null,
+    heartbeatDetails: formatPayload(heartbeatDetails),
+    scheduledTime: formatTimestampToDatetime(scheduledTime),
     lastHeartbeatTime: formatTimestampToDatetime(lastHeartbeatTime),
     lastStartedTime: formatTimestampToDatetime(lastStartedTime),
-    scheduledTime: formatTimestampToDatetime(scheduledTime),
     expirationTime: formatTimestampToDatetime(expirationTime),
-    heartbeatDetails: formatPayload(heartbeatDetails),
-    lastFailureDetails: formatFailureDetails(lastFailure),
-    lastFailureReason: lastFailure?.reason,
+    scheduleId: parseInt(scheduleId),
   };
 }

src/utils/data-formatters/format-workflow-history-event/__tests__/index.test.ts.snapshot

@@ -47,7 +47,7 @@ exports[`formatWorkflowHistoryEvent should format workflow activityTaskFailedEve
   "eventId": 11,
   "eventType": "ActivityTaskFailed",
   "identity": "cadence@958ab341-a376-431n-a17a-ed7d8a97ba91",
-  "reason": "",
+  "reason": null,
   "scheduledEventId": 7,
   "startedEventId": 9,
   "taskId": "22647174813",
@@ -98,7 +98,7 @@ exports[`formatWorkflowHistoryEvent should format workflow activityTaskStartedEv
   "eventType": "ActivityTaskStarted",
   "identity": "cadence@958ab341-a375-431b-a17a-ed7d8a97ba91",
   "lastFailureDetails": null,
-  "lastFailureReason": "",
+  "lastFailureReason": null,
   "requestId": "27e61b29-7rc9-48f4-9e78-0366e9ffd413",
   "scheduledEventId": 7,
   "taskId": "22647174807",
@@ -113,7 +113,7 @@ exports[`formatWorkflowHistoryEvent should format workflow activityTaskTimedOutE
   "eventId": 12,
   "eventType": "ActivityTaskTimedOut",
   "lastFailureDetails": null,
-  "lastFailureReason": "",
+  "lastFailureReason": null,
   "scheduledEventId": 7,
   "startedEventId": 9,
   "taskId": "22647174813",
@@ -186,7 +186,7 @@ exports[`formatWorkflowHistoryEvent should format workflow childWorkflowExecutio
   "eventId": 47,
   "eventType": "ChildWorkflowExecutionFailed",
   "initiatedEventId": 40,
-  "reason": "",
+  "reason": null,
   "startedEventId": 42,
   "taskId": "5877269789",
   "timestamp": 2024-09-08T04:27:58.993Z,
@@ -269,7 +269,7 @@ exports[`formatWorkflowHistoryEvent should format workflow decisionTaskCompleted
   "binaryChecksum": "cadence:eb16a90a9182002897d7a6c6585871eedace71d1",
   "eventId": 4,
   "eventType": "DecisionTaskCompleted",
-  "executionContext": "",
+  "executionContext": null,
   "identity": "cadence@958ab342-a376-431b-a17a-ed7d8a97ba91",
   "scheduledEventId": "2",
   "startedEventId": "3",
@@ -290,7 +290,7 @@ exports[`formatWorkflowHistoryEvent should format workflow decisionTaskFailedEve
   "forkEventVersion": 0,
   "identity": "cadence@958ab341-a375-431b-a27a-ed7d8a97ba91",
   "newRunId": "",
-  "reason": "",
+  "reason": null,
   "requestId": "66f7f58b-3d3b-4178-972a-fa7825ceec39",
   "scheduledEventId": 2,
   "startedEventId": 3,
@@ -511,7 +511,7 @@ exports[`formatWorkflowHistoryEvent should format workflow startChildWorkflowExe
 exports[`formatWorkflowHistoryEvent should format workflow startChildWorkflowExecutionInitiatedEventAttributes to match snapshot 1`] = `
 {
   "control": null,
-  "cronSchedule": "",
+  "cronSchedule": null,
   "decisionTaskCompletedEventId": 4,
   "delayStartSeconds": null,
   "domain": "cadence-domain",
@@ -654,7 +654,7 @@ exports[`formatWorkflowHistoryEvent should format workflow workflowExecutionCont
   "eventType": "WorkflowExecutionContinuedAsNew",
   "executionStartToCloseTimeoutSeconds": 1080,
   "failureDetails": null,
-  "failureReason": "",
+  "failureReason": null,
   "header": {
     "fields": {},
   },

src/utils/data-formatters/format-workflow-history-event/format-activity-task-canceled-event.ts

@@ -15,11 +15,11 @@ const formatActivityTaskCanceledEvent = ({
 }: ActivityTaskCanceledEvent) => {
   return {
     ...formatWorkflowCommonEventFields(eventFields),
-    ...eventAttributes,
     details: formatPayload(details),
     latestCancelRequestedEventId: parseInt(latestCancelRequestedEventId),
     scheduledEventId: parseInt(scheduledEventId),
     startedEventId: parseInt(startedEventId),
+    ...eventAttributes,
   };
 };
 

src/utils/data-formatters/format-workflow-history-event/format-activity-task-completed-event.ts

@@ -8,16 +8,18 @@ const formatActivityTaskCompletedEvent = ({
     result,
     scheduledEventId,
     startedEventId,
+    identity,
     ...eventAttributes
   },
   ...eventFields
 }: ActivityTaskCompletedEvent) => {
   return {
     ...formatWorkflowCommonEventFields(eventFields),
-    ...eventAttributes,
     result: formatPayload(result),
+    identity,
     scheduledEventId: parseInt(scheduledEventId),
     startedEventId: parseInt(startedEventId),
+    ...eventAttributes,
   };
 };
 

src/utils/data-formatters/format-workflow-history-event/format-activity-task-failed-event.ts

@@ -8,17 +8,19 @@ const formatActivityTaskFailedEvent = ({
     failure,
     scheduledEventId,
     startedEventId,
+    identity,
     ...eventAttributes
   },
   ...eventFields
 }: ActivityTaskFailedEvent) => {
   return {
     ...formatWorkflowCommonEventFields(eventFields),
-    ...eventAttributes,
     details: formatFailureDetails(failure),
-    reason: failure?.reason || '',
+    reason: failure?.reason || null,
+    identity,
     scheduledEventId: parseInt(scheduledEventId),
     startedEventId: parseInt(startedEventId),
+    ...eventAttributes,
   };
 };
 

src/utils/data-formatters/format-workflow-history-event/format-activity-task-scheduled-event.ts

@@ -26,11 +26,12 @@ const formatActivityTaskScheduledEvent = ({
   return {
     ...formatWorkflowCommonEventFields(eventFields),
     ...eventAttributes,
-    decisionTaskCompletedEventId: parseInt(decisionTaskCompletedEventId),
-    domain: domain || null,
-    header: formatPayloadMap(header, 'fields'),
-    heartbeatTimeoutSeconds: formatDurationToSeconds(heartbeatTimeout),
+    taskList: {
+      kind: formatEnum(taskList?.kind, 'TASK_LIST_KIND'),
+      name: taskList?.name || null,
+    },
     input: formatInputPayload(input),
+    heartbeatTimeoutSeconds: formatDurationToSeconds(heartbeatTimeout),
     retryPolicy: formatRetryPolicy(retryPolicy),
     scheduleToCloseTimeoutSeconds: formatDurationToSeconds(
       scheduleToCloseTimeout
@@ -39,10 +40,9 @@ const formatActivityTaskScheduledEvent = ({
       scheduleToStartTimeout
     ),
     startToCloseTimeoutSeconds: formatDurationToSeconds(startToCloseTimeout),
-    taskList: {
-      kind: formatEnum(taskList?.kind, 'TASK_LIST_KIND'),
-      name: taskList?.name || null,
-    },
+    domain: domain || null,
+    decisionTaskCompletedEventId: parseInt(decisionTaskCompletedEventId),
+    header: formatPayloadMap(header, 'fields'),
   };
 };
 

src/utils/data-formatters/format-workflow-history-event/format-activity-task-started-event.ts

@@ -7,16 +7,22 @@ const formatActivityTaskStartedEvent = ({
   activityTaskStartedEventAttributes: {
     lastFailure,
     scheduledEventId,
+    requestId,
+    identity,
+    attempt,
     ...eventAttributes
   },
   ...eventFields
 }: ActivityTaskStartedEvent) => {
   return {
     ...formatWorkflowCommonEventFields(eventFields),
-    ...eventAttributes,
     lastFailureDetails: formatFailureDetails(lastFailure),
-    lastFailureReason: lastFailure?.reason || '',
+    lastFailureReason: lastFailure?.reason || null,
+    attempt,
+    identity,
     scheduledEventId: parseInt(scheduledEventId),
+    requestId,
+    ...eventAttributes,
   };
 };
 

src/utils/data-formatters/format-workflow-history-event/format-activity-task-timed-out-event.ts

@@ -22,7 +22,7 @@ const formatActivityTaskTimedOutEvent = ({
     timeoutType: formatEnum(timeoutType, 'TIMEOUT_TYPE', 'pascal'),
     details: formatPayload(details),
     lastFailureDetails: formatFailureDetails(lastFailure),
-    lastFailureReason: lastFailure?.reason || '',
+    lastFailureReason: lastFailure?.reason || null,
     scheduledEventId: parseInt(scheduledEventId),
     startedEventId: parseInt(startedEventId),
   };

src/utils/data-formatters/format-workflow-history-event/format-child-workflow-execution-canceled-event.ts

@@ -14,8 +14,8 @@ const formatChildWorkflowExecutionCanceledEvent = ({
 }: ChildWorkflowExecutionCanceledEvent) => {
   return {
     ...formatWorkflowCommonEventFields(eventFields),
-    ...eventAttributes,
     details: formatPayload(details),
+    ...eventAttributes,
     initiatedEventId: parseInt(initiatedEventId),
     startedEventId: parseInt(startedEventId),
   };