Merge pull request #141 from joomcode/fix/map-additional-payload-in-steps

fix: map additional payload in step via mapLogPayloadInReport

Author: uid11

src/step.ts

@@ -4,7 +4,7 @@ import {setCustomInspectOnFunction} from './utils/fn';
 import {generalLog} from './utils/generalLog';
 import {logAndGetLogEvent} from './utils/log';
 import {setReadonlyProperty} from './utils/object';
-import {processStepError, runStepBody} from './utils/step';
+import {processStepError, runStepBody, updateStepPayload} from './utils/step';
 
 import type {
   LogEvent,
@@ -87,7 +87,7 @@ export const step = async (
       setReadonlyProperty(logEvent, 'endTime', endTime);
 
       if (payload !== undefined) {
-        setReadonlyProperty(logEvent, 'payload', {...logEvent.payload, ...payload});
+        updateStepPayload(logEvent, payload);
       }
 
       generalLog(`Step "${name}" completed`, {

src/utils/step/index.ts

@@ -4,3 +4,5 @@ export {getTopStep} from './getTopStep';
 export {processStepError} from './processStepError';
 /** @internal */
 export {runStepBody} from './runStepBody';
+/** @internal */
+export {updateStepPayload} from './updateStepPayload';

src/utils/step/updateStepPayload.ts

@@ -0,0 +1,18 @@
+import {getFullPackConfig} from '../config';
+import {setReadonlyProperty} from '../object';
+
+import type {LogEvent, LogPayload} from '../../types/internal';
+
+/**
+ * Updates `step` log payload with the values returned by the step body.
+ * @internal
+ */
+export const updateStepPayload = (logEvent: LogEvent, additionalPayload: LogPayload): void => {
+  const {mapLogPayloadInReport} = getFullPackConfig();
+
+  const payloadInReport = mapLogPayloadInReport(logEvent.message, additionalPayload, logEvent.type);
+
+  if (payloadInReport !== undefined && payloadInReport !== 'skipLog') {
+    setReadonlyProperty(logEvent, 'payload', {...logEvent.payload, ...payloadInReport});
+  }
+};