Files
qwen-code/packages/core/src/utils/partUtils.test.ts

302 lines
10 KiB
TypeScript

/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect } from 'vitest';
import {
partToString,
getResponseText,
flatMapTextParts,
appendToLastTextPart,
} from './partUtils.js';
import type { GenerateContentResponse, Part, PartUnion } from '@google/genai';
const mockResponse = (
parts?: Array<{ text?: string; functionCall?: unknown }>,
): GenerateContentResponse => ({
candidates: parts
? [{ content: { parts: parts as Part[], role: 'model' }, index: 0 }]
: [],
promptFeedback: { safetyRatings: [] },
text: undefined,
data: undefined,
functionCalls: undefined,
executableCode: undefined,
codeExecutionResult: undefined,
});
describe('partUtils', () => {
describe('partToString (default behavior)', () => {
it('should return empty string for undefined or null', () => {
// @ts-expect-error Testing invalid input
expect(partToString(undefined)).toBe('');
// @ts-expect-error Testing invalid input
expect(partToString(null)).toBe('');
});
it('should return string input unchanged', () => {
expect(partToString('hello')).toBe('hello');
});
it('should concatenate strings from an array', () => {
expect(partToString(['a', 'b'])).toBe('ab');
});
it('should return text property when provided a text part', () => {
expect(partToString({ text: 'hi' })).toBe('hi');
});
it('should return empty string for non-text parts', () => {
const part: Part = { inlineData: { mimeType: 'image/png', data: '' } };
expect(partToString(part)).toBe('');
const part2: Part = { functionCall: { name: 'test' } };
expect(partToString(part2)).toBe('');
});
});
describe('partToString (verbose)', () => {
const verboseOptions = { verbose: true };
it('should return empty string for undefined or null', () => {
// @ts-expect-error Testing invalid input
expect(partToString(undefined, verboseOptions)).toBe('');
// @ts-expect-error Testing invalid input
expect(partToString(null, verboseOptions)).toBe('');
});
it('should return string input unchanged', () => {
expect(partToString('hello', verboseOptions)).toBe('hello');
});
it('should join parts if the value is an array', () => {
const parts = ['hello', { text: ' world' }];
expect(partToString(parts, verboseOptions)).toBe('hello world');
});
it('should return the text property if the part is an object with text', () => {
const part: Part = { text: 'hello world' };
expect(partToString(part, verboseOptions)).toBe('hello world');
});
it('should return descriptive string for videoMetadata part', () => {
const part = { videoMetadata: {} } as Part;
expect(partToString(part, verboseOptions)).toBe('[Video Metadata]');
});
it('should return descriptive string for thought part', () => {
const part = { thought: 'thinking' } as unknown as Part;
expect(partToString(part, verboseOptions)).toBe('[Thought: thinking]');
});
it('should return descriptive string for codeExecutionResult part', () => {
const part = { codeExecutionResult: {} } as Part;
expect(partToString(part, verboseOptions)).toBe(
'[Code Execution Result]',
);
});
it('should return descriptive string for executableCode part', () => {
const part = { executableCode: {} } as Part;
expect(partToString(part, verboseOptions)).toBe('[Executable Code]');
});
it('should return descriptive string for fileData part', () => {
const part = { fileData: {} } as Part;
expect(partToString(part, verboseOptions)).toBe('[File Data]');
});
it('should return descriptive string for functionCall part', () => {
const part = { functionCall: { name: 'myFunction' } } as Part;
expect(partToString(part, verboseOptions)).toBe(
'[Function Call: myFunction]',
);
});
it('should return descriptive string for functionResponse part', () => {
const part = { functionResponse: { name: 'myFunction' } } as Part;
expect(partToString(part, verboseOptions)).toBe(
'[Function Response: myFunction]',
);
});
it('should return descriptive string for inlineData part', () => {
const part = { inlineData: { mimeType: 'image/png', data: '' } } as Part;
expect(partToString(part, verboseOptions)).toBe('<image/png>');
});
it('should return an empty string for an unknown part type', () => {
const part: Part = {};
expect(partToString(part, verboseOptions)).toBe('');
});
it('should handle complex nested arrays with various part types', () => {
const parts = [
'start ',
{ text: 'middle' },
[
{ functionCall: { name: 'func1' } },
' end',
{ inlineData: { mimeType: 'audio/mp3', data: '' } },
],
];
expect(partToString(parts as Part, verboseOptions)).toBe(
'start middle[Function Call: func1] end<audio/mp3>',
);
});
});
describe('getResponseText', () => {
it('should return null when no candidates exist', () => {
const response = mockResponse(undefined);
expect(getResponseText(response)).toBeNull();
});
it('should return concatenated text from first candidate', () => {
const result = mockResponse([{ text: 'a' }, { text: 'b' }]);
expect(getResponseText(result)).toBe('ab');
});
it('should ignore parts without text', () => {
const result = mockResponse([{ functionCall: {} }, { text: 'hello' }]);
expect(getResponseText(result)).toBe('hello');
});
it('should return null when candidate has no parts', () => {
const result = mockResponse([]);
expect(getResponseText(result)).toBeNull();
});
it('should return null if the first candidate has no content property', () => {
const response: GenerateContentResponse = {
candidates: [
{
index: 0,
},
],
promptFeedback: { safetyRatings: [] },
text: undefined,
data: undefined,
functionCalls: undefined,
executableCode: undefined,
codeExecutionResult: undefined,
};
expect(getResponseText(response)).toBeNull();
});
});
describe('flatMapTextParts', () => {
// A simple async transform function that splits a string into character parts.
const splitCharsTransform = async (text: string): Promise<PartUnion[]> =>
text.split('').map((char) => ({ text: char }));
it('should return an empty array for empty input', async () => {
const result = await flatMapTextParts([], splitCharsTransform);
expect(result).toEqual([]);
});
it('should transform a simple string input', async () => {
const result = await flatMapTextParts('hi', splitCharsTransform);
expect(result).toEqual([{ text: 'h' }, { text: 'i' }]);
});
it('should transform a single text part object', async () => {
const result = await flatMapTextParts(
{ text: 'cat' },
splitCharsTransform,
);
expect(result).toEqual([{ text: 'c' }, { text: 'a' }, { text: 't' }]);
});
it('should transform an array of text parts and flatten the result', async () => {
// A transform that duplicates the text to test the "flatMap" behavior.
const duplicateTransform = async (text: string): Promise<PartUnion[]> => [
{ text: `${text}` },
{ text: `${text}` },
];
const parts = [{ text: 'a' }, { text: 'b' }];
const result = await flatMapTextParts(parts, duplicateTransform);
expect(result).toEqual([
{ text: 'a' },
{ text: 'a' },
{ text: 'b' },
{ text: 'b' },
]);
});
it('should pass through non-text parts unmodified', async () => {
const nonTextPart: Part = { functionCall: { name: 'do_stuff' } };
const result = await flatMapTextParts(nonTextPart, splitCharsTransform);
expect(result).toEqual([nonTextPart]);
});
it('should handle a mix of text and non-text parts in an array', async () => {
const nonTextPart: Part = {
inlineData: { mimeType: 'image/jpeg', data: '' },
};
const parts: PartUnion[] = [{ text: 'go' }, nonTextPart, ' stop'];
const result = await flatMapTextParts(parts, splitCharsTransform);
expect(result).toEqual([
{ text: 'g' },
{ text: 'o' },
nonTextPart, // Should be passed through
{ text: ' ' },
{ text: 's' },
{ text: 't' },
{ text: 'o' },
{ text: 'p' },
]);
});
it('should handle a transform that returns an empty array', async () => {
const removeTransform = async (_text: string): Promise<PartUnion[]> => [];
const parts: PartUnion[] = [
{ text: 'remove' },
{ functionCall: { name: 'keep' } },
];
const result = await flatMapTextParts(parts, removeTransform);
expect(result).toEqual([{ functionCall: { name: 'keep' } }]);
});
});
describe('appendToLastTextPart', () => {
it('should append to an empty prompt', () => {
const prompt: PartUnion[] = [];
const result = appendToLastTextPart(prompt, 'new text');
expect(result).toEqual([{ text: 'new text' }]);
});
it('should append to a prompt with a string as the last part', () => {
const prompt: PartUnion[] = ['first part'];
const result = appendToLastTextPart(prompt, 'new text');
expect(result).toEqual(['first part\n\nnew text']);
});
it('should append to a prompt with a text part object as the last part', () => {
const prompt: PartUnion[] = [{ text: 'first part' }];
const result = appendToLastTextPart(prompt, 'new text');
expect(result).toEqual([{ text: 'first part\n\nnew text' }]);
});
it('should append a new text part if the last part is not a text part', () => {
const nonTextPart: Part = { functionCall: { name: 'do_stuff' } };
const prompt: PartUnion[] = [nonTextPart];
const result = appendToLastTextPart(prompt, 'new text');
expect(result).toEqual([nonTextPart, { text: '\n\nnew text' }]);
});
it('should not append anything if the text to append is empty', () => {
const prompt: PartUnion[] = ['first part'];
const result = appendToLastTextPart(prompt, '');
expect(result).toEqual(['first part']);
});
it('should use a custom separator', () => {
const prompt: PartUnion[] = ['first part'];
const result = appendToLastTextPart(prompt, 'new text', '---');
expect(result).toEqual(['first part---new text']);
});
});
});