test: add unit tests

Author: EstebanRomero84

src/components/agent-preview-react.tsx

@@ -71,20 +71,22 @@ export const saveTranscriptsToFile = (
   }
 };
 
-const getTraces = async (
+export const getTraces = async (
   agent: AgentPreviewBase,
   sessionId: string,
   messageIds: string[],
   logger: Logger
 ): Promise<PlannerResponse[]> => {
-  try {
-    const traces = await agent.traces(sessionId, messageIds);
-    return traces;
-  } catch (e) {
-    const sfError = SfError.wrap(e);
-    logger.info(`Error obtaining traces: ${sfError.name} - ${sfError.message}`, { sessionId, messageIds });
-    return [];
+  if (messageIds.length > 0) {
+    try {
+      const traces = await agent.traces(sessionId, messageIds);
+      return traces;
+    } catch (e) {
+      const sfError = SfError.wrap(e);
+      logger.info(`Error obtaining traces: ${sfError.name} - ${sfError.message}`, { sessionId, messageIds });
+    }
   }
+  return [];
 };
 
 /**

test/components/agent-preview-react.test.ts

@@ -19,8 +19,13 @@ import * as os from 'node:os';
 import * as path from 'node:path';
 import { describe, it, beforeEach, afterEach } from 'mocha';
 import { expect } from 'chai';
+import sinon, { SinonStubbedInstance } from 'sinon';
 import type { AgentPreviewSendResponse } from '@salesforce/agents';
-import { saveTranscriptsToFile } from '../../src/components/agent-preview-react.js';
+import { PlannerResponse } from '@salesforce/agents/lib/types.js';
+import type { Logger } from '@salesforce/core';
+import type { AgentPreviewBase } from '@salesforce/agents';
+import { saveTranscriptsToFile, getTraces } from '../../src/components/agent-preview-react.js';
+import { trace1, trace2 } from '../testData.js';
 
 describe('AgentPreviewReact saveTranscriptsToFile', () => {
   let testDir: string;
@@ -139,4 +144,76 @@ describe('AgentPreviewReact saveTranscriptsToFile', () => {
     // Should parse as valid JSON
     expect(() => JSON.parse(content) as unknown).to.not.throw();
   });
+
+  it('should write traces.json when traces are provided', () => {
+    const outputDir = path.join(testDir, 'output');
+    const messages: Array<{ timestamp: Date; role: string; content: string }> = [];
+    const responses: AgentPreviewSendResponse[] = [];
+    const traces: PlannerResponse[] = [trace1, trace2];
+
+    saveTranscriptsToFile(outputDir, messages, responses, traces);
+
+    const tracesPath = path.join(outputDir, 'traces.json');
+    expect(fs.existsSync(tracesPath)).to.be.true;
+
+    const content = JSON.parse(fs.readFileSync(tracesPath, 'utf8')) as PlannerResponse[];
+    expect(content).to.have.lengthOf(2);
+  });
+});
+
+describe('AgentPreviewReact getTraces', () => {
+  let mockAgent: SinonStubbedInstance<AgentPreviewBase>;
+  let mockLogger: SinonStubbedInstance<Logger>;
+  const sessionId = 'session-123';
+  const messageIds = ['msg-1', 'msg-2'];
+
+  beforeEach(() => {
+    mockAgent = {
+      traces: sinon.stub(),
+    } as SinonStubbedInstance<AgentPreviewBase>;
+
+    mockLogger = {
+      info: sinon.stub(),
+    } as SinonStubbedInstance<Logger>;
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  it('should return traces when agent.traces succeeds', async () => {
+    const expectedTraces: PlannerResponse[] = [trace1];
+
+    mockAgent.traces.resolves(expectedTraces);
+
+    const result = await getTraces(mockAgent, sessionId, messageIds, mockLogger);
+
+    expect(result).to.deep.equal(expectedTraces);
+    expect(mockAgent.traces.calledWith(sessionId, messageIds)).to.be.true;
+    expect(mockLogger.info.called).to.be.false;
+  });
+
+  it('should return empty array when agent.traces throws an error', async () => {
+    const error = new Error('Failed to get traces');
+    mockAgent.traces.rejects(error);
+
+    const result = await getTraces(mockAgent, sessionId, messageIds, mockLogger);
+
+    expect(result).to.deep.equal([]);
+    expect(mockAgent.traces.calledWith(sessionId, messageIds)).to.be.true;
+    expect(
+      mockLogger.info.calledWith('Error obtaining traces: Error - Failed to get traces', { sessionId, messageIds })
+    ).to.be.true;
+  });
+
+  it('should handle empty messageIds array', async () => {
+    const expectedTraces: PlannerResponse[] = [];
+    mockAgent.traces.resolves(expectedTraces);
+
+    const result = await getTraces(mockAgent, sessionId, [], mockLogger);
+
+    expect(result).to.deep.equal(expectedTraces);
+    expect(mockAgent.traces.notCalled).to.be.true;
+    expect(mockLogger.info.called).to.be.false;
+  });
 });

test/testData.ts

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2025, Salesforce, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { PlannerResponse } from '@salesforce/agents/lib/types.js';
+
+export const trace1: PlannerResponse = {
+  type: 'PlanSuccessResponse',
+  planId: 'plan-1',
+  sessionId: 'session-123',
+  intent: 'get_weather',
+  topic: 'weather',
+  plan: [
+    {
+      type: 'FunctionStep',
+      function: {
+        name: 'get_weather',
+        input: { location: 'Madrid' },
+        output: { temperature: 25, condition: 'sunny' },
+      },
+      executionLatency: 100,
+      startExecutionTime: Date.now(),
+      endExecutionTime: Date.now() + 100,
+    },
+  ],
+};
+
+export const trace2: PlannerResponse = {
+  type: 'PlanSuccessResponse',
+  planId: 'plan-4',
+  sessionId: 'session-456',
+  intent: 'send_message',
+  topic: 'communication',
+  plan: [
+    {
+      type: 'PlannerResponseStep',
+      message: 'Hello world',
+      responseType: 'text',
+      isContentSafe: true,
+      safetyScore: {
+        // eslint-disable-next-line camelcase
+        safety_score: 0.9,
+        // eslint-disable-next-line camelcase
+        category_scores: {
+          toxicity: 0.1,
+          hate: 0.0,
+          identity: 0.0,
+          violence: 0.0,
+          physical: 0.0,
+          sexual: 0.0,
+          profanity: 0.0,
+          biased: 0.0,
+        },
+      },
+    },
+  ],
+};