firefox-main/browser/components/aiwindow/ui/test/xpcshell/test_ChatConversation.js (file symbol)

Source code

Revision control

Copy as Markdown

Other Tools

Test Info: Warnings

/* Any copyright is dedicated to the Public Domain.
do_get_profile();
const { ChatConversation, MESSAGE_ROLE } = ChromeUtils.importESModule(
"moz-src:///browser/components/aiwindow/ui/modules/ChatStore.sys.mjs"
);
const { UserRoleOpts, AssistantRoleOpts, ToolRoleOpts } =
ChromeUtils.importESModule(
"moz-src:///browser/components/aiwindow/ui/modules/ChatMessage.sys.mjs"
);
add_task(function test_ChatConversation_constructor_defaults() {
const conversation = new ChatConversation({});
Assert.withSoftAssertions(function (soft) {
soft.equal(conversation.id.length, 12);
soft.ok(Array.isArray(conversation.messages));
soft.ok(!isNaN(conversation.createdDate));
soft.ok(!isNaN(conversation.updatedDate));
soft.strictEqual(conversation.title, undefined);
soft.strictEqual(conversation.description, undefined);
soft.strictEqual(conversation.pageUrl, undefined);
soft.strictEqual(conversation.pageMeta, undefined);
});
});
add_task(function test_ChatConversation_addMessage() {
const conversation = new ChatConversation({});
const content = {
type: "text",
content: "hello world",
};
conversation.addMessage(
MESSAGE_ROLE.USER,
content,
0
);
const message = conversation.messages[0];
Assert.withSoftAssertions(function (soft) {
soft.strictEqual(message.role, MESSAGE_ROLE.USER);
soft.strictEqual(message.content, content);
soft.strictEqual(message.pageUrl.href, "https://www.mozilla.com/");
soft.strictEqual(message.turnIndex, 0);
});
});
add_task(function test_invalidRole_ChatConversation_addMessage() {
const conversation = new ChatConversation({});
const content = {
type: "text",
content: "hello world",
};
conversation.addMessage(313, content, new URL("https://www.mozilla.com"), 0);
Assert.equal(conversation.messages.length, 0);
});
add_task(function test_negativeTurnIndex_ChatConversation_addMessage() {
const conversation = new ChatConversation({});
const content = {
type: "text",
content: "hello world",
};
conversation.addMessage(
MESSAGE_ROLE.USER,
content,
-1
);
const message = conversation.messages[0];
Assert.equal(message.turnIndex, 0);
});
add_task(function test_parentMessageId_ChatConversation_addMessage() {
const conversation = new ChatConversation({});
const content = {
type: "text",
content: "hello world",
};
conversation.addMessage(
MESSAGE_ROLE.USER,
content,
0
);
conversation.addMessage(
MESSAGE_ROLE.ASSISTANT,
content,
0
);
const userMsg = conversation.messages[0];
const assistantMsg = conversation.messages[1];
Assert.equal(assistantMsg.parentMessageId, userMsg.id);
});
add_task(function test_ordinal_ChatConversation_addMessage() {
const conversation = new ChatConversation({});
const content = {
type: "text",
content: "hello world",
};
conversation.addMessage(
MESSAGE_ROLE.USER,
content,
0
);
conversation.addMessage(
MESSAGE_ROLE.ASSISTANT,
content,
0
);
const userMsg = conversation.messages[0];
const assistantMsg = conversation.messages[1];
Assert.withSoftAssertions(function (soft) {
soft.equal(userMsg.ordinal, 1);
soft.equal(assistantMsg.ordinal, 2);
});
});
add_task(function test_ChatConversation_addUserMessage() {
const conversation = new ChatConversation({});
const content = "user to assistant msg";
conversation.addUserMessage(content, "https://www.mozilla.com");
const message = conversation.messages[0];
Assert.withSoftAssertions(function (soft) {
soft.equal(message.role, MESSAGE_ROLE.USER);
soft.equal(message.turnIndex, 1);
soft.deepEqual(message.pageUrl, new URL("https://www.mozilla.com"));
soft.deepEqual(message.content, {
type: "text",
body: "user to assistant msg",
});
});
});
add_task(function test_revisionRootMessageId_ChatConversation_addUserMessage() {
const conversation = new ChatConversation({});
const content = "user to assistant msg";
conversation.addUserMessage(content, "https://www.firefox.com");
const message = conversation.messages[0];
Assert.equal(message.revisionRootMessageId, message.id);
});
add_task(function test_opts_ChatConversation_addUserMessage() {
const conversation = new ChatConversation({});
const content = "user to assistant msg";
conversation.addUserMessage(
content,
new UserRoleOpts("321")
);
const message = conversation.messages[0];
Assert.equal(message.revisionRootMessageId, "321");
});
add_task(function test_ChatConversation_addAssistantMessage() {
const conversation = new ChatConversation({});
const content = "response from assistant";
conversation.addAssistantMessage("text", content);
const message = conversation.messages[0];
Assert.withSoftAssertions(function (soft) {
soft.equal(message.role, MESSAGE_ROLE.ASSISTANT);
soft.equal(message.turnIndex, 0);
soft.deepEqual(message.pageUrl, null);
soft.deepEqual(message.content, {
type: "text",
body: "response from assistant",
});
soft.strictEqual(message.modelId, null, "modelId should default to false");
soft.strictEqual(message.params, null, "params should default to null");
soft.strictEqual(message.usage, null, "usage should default to null");
soft.strictEqual(
message.insightsEnabled,
false,
"insightsEnabled should default to false"
);
soft.strictEqual(
message.insightsFlagSource,
null,
"insightsFlagSource should default to null"
);
soft.deepEqual(
message.insightsApplied,
[],
"insightsApplied should default to emtpy array"
);
soft.deepEqual(
message.webSearchQueries,
[],
"webSearchQueries should default to emtpy array"
);
});
});
add_task(function test_opts_ChatConversation_addAssistantMessage() {
const conversation = new ChatConversation({});
const content = "response from assistant";
const assistantOpts = new AssistantRoleOpts(
"the-model-id",
{ some: "params for model" },
{ usage: "data" },
true,
1,
["insight"],
["search"]
);
conversation.addAssistantMessage("text", content, assistantOpts);
const message = conversation.messages[0];
Assert.withSoftAssertions(function (soft) {
soft.equal(message.role, MESSAGE_ROLE.ASSISTANT);
soft.equal(message.turnIndex, 0);
soft.deepEqual(message.pageUrl, null);
soft.deepEqual(message.content, {
type: "text",
body: "response from assistant",
});
soft.strictEqual(
message.modelId,
"the-model-id",
"modelId should be 'the-model-id'"
);
soft.deepEqual(
message.params,
{ some: "params for model" },
'params should equal { some: "params for model"}'
);
soft.deepEqual(
message.usage,
{ usage: "data" },
'usage should equal {"usage": "data"}'
);
soft.strictEqual(
message.insightsEnabled,
true,
"insightsEnabled should equal true"
);
soft.strictEqual(
message.insightsFlagSource,
1,
"insightsFlagSource equal 1"
);
soft.deepEqual(
message.insightsApplied,
["insight"],
"insightsApplied should equal ['insight']"
);
soft.deepEqual(
message.webSearchQueries,
["search"],
"insightsApplied should equal ['search']"
);
});
});
add_task(function test_ChatConversation_addToolCallMessage() {
const conversation = new ChatConversation({});
const content = {
random: "tool call specific keys",
};
conversation.addToolCallMessage(content);
const message = conversation.messages[0];
Assert.withSoftAssertions(function (soft) {
soft.equal(message.role, MESSAGE_ROLE.TOOL);
soft.equal(message.turnIndex, 0);
soft.deepEqual(message.pageUrl, null);
soft.deepEqual(message.content, {
random: "tool call specific keys",
});
soft.equal(message.modelId, null, "modelId should default to null");
});
});
add_task(function test_opts_ChatConversation_addToolCallMessage() {
const conversation = new ChatConversation({});
const content = {
random: "tool call specific keys",
};
conversation.addToolCallMessage(content, new ToolRoleOpts("the-model-id"));
const message = conversation.messages[0];
Assert.withSoftAssertions(function (soft) {
soft.equal(message.role, MESSAGE_ROLE.TOOL);
soft.equal(message.turnIndex, 0);
soft.deepEqual(message.pageUrl, null);
soft.deepEqual(message.content, {
random: "tool call specific keys",
});
soft.equal(
message.modelId,
"the-model-id",
"modelId should equal the-model-id"
);
});
});
add_task(function test_ChatConversation_addSystemMessage() {
const conversation = new ChatConversation({});
const content = {
random: "system call specific keys",
};
conversation.addSystemMessage("text", content);
const message = conversation.messages[0];
Assert.withSoftAssertions(function (soft) {
soft.equal(message.role, MESSAGE_ROLE.SYSTEM);
soft.equal(message.turnIndex, 0);
soft.deepEqual(message.pageUrl, null);
soft.deepEqual(message.content, {
type: "text",
body: { random: "system call specific keys" },
});
});
});
add_task(function test_ChatConversation_getSitesList() {
const conversation = new ChatConversation({});
const content = "user to assistant msg";
conversation.addUserMessage(content, "https://www.mozilla.com");
conversation.addUserMessage(content, "https://www.mozilla.com");
conversation.addUserMessage(content, "https://www.firefox.com");
conversation.addUserMessage(content, "https://www.cnn.com");
conversation.addUserMessage(content, "https://www.espn.com");
conversation.addUserMessage(content, "https://www.espn.com");
const sites = conversation.getSitesList();
Assert.deepEqual(sites, [
URL.parse("https://www.mozilla.com/"),
URL.parse("https://www.firefox.com/"),
URL.parse("https://www.cnn.com/"),
URL.parse("https://www.espn.com/"),
]);
});
add_task(function test_ChatConversation_getMostRecentPageVisited() {
const conversation = new ChatConversation({});
const content = "user to assistant msg";
conversation.addUserMessage(content, "https://www.mozilla.com");
conversation.addUserMessage(content, "https://www.mozilla.com");
conversation.addUserMessage(content, "https://www.firefox.com");
conversation.addUserMessage(content, "https://www.cnn.com");
conversation.addUserMessage(content, "https://www.espn.com");
conversation.addUserMessage(content, "https://www.espn.com");
const mostRecentPageVisited = conversation.getMostRecentPageVisited();
Assert.equal(mostRecentPageVisited, "https://www.espn.com/");
});
add_task(function test_noBrowsing_ChatConversation_getMostRecentPageVisited() {
const conversation = new ChatConversation({});
const content = "user to assistant msg";
conversation.addUserMessage(content, "about:aiwindow");
conversation.addUserMessage(content, "");
conversation.addUserMessage(content, null);
const mostRecentPageVisited = conversation.getMostRecentPageVisited();
Assert.equal(mostRecentPageVisited, null);
});
add_task(function test_ChatConversation_renderState() {
const conversation = new ChatConversation({});
const content = "user to assistant msg";
conversation.addUserMessage(content, "about:aiwindow");
conversation.addToolCallMessage("some content");
conversation.addAssistantMessage("text", "a response");
conversation.addUserMessage(content, "about:aiwindow");
conversation.addSystemMessage("text", "some system message");
conversation.addAssistantMessage("text", "a response");
const renderState = conversation.renderState();
Assert.deepEqual(renderState, [
conversation.messages[0],
conversation.messages[2],
conversation.messages[3],
conversation.messages[5],
]);
});
add_task(function test_ChatConversation_currentTurnIndex() {
const conversation = new ChatConversation({});
const content = "user to assistant msg";
conversation.addSystemMessage("text", "the system prompt");
conversation.addUserMessage(content, "about:aiwindow");
conversation.addAssistantMessage("text", "a response");
conversation.addUserMessage(content, "about:aiwindow");
conversation.addAssistantMessage("text", "a response");
conversation.addUserMessage(content, "about:aiwindow");
conversation.addAssistantMessage("text", "a response");
conversation.addUserMessage(content, "about:aiwindow");
conversation.addAssistantMessage("text", "a response");
conversation.addUserMessage(content, "about:aiwindow");
conversation.addAssistantMessage("text", "a response");
Assert.deepEqual(conversation.currentTurnIndex(), 4);
});
add_task(function test_ChatConversation_helpersTurnIndexing() {
const conversation = new ChatConversation({});
conversation.addSystemMessage("text", "the system prompt");
conversation.addUserMessage("a user's prompt", "https://www.somesite.com");
conversation.addToolCallMessage({ some: "tool call details" });
conversation.addAssistantMessage("text", "the llm response");
conversation.addUserMessage(
"a user's second prompt",
);
conversation.addToolCallMessage({ some: "more tool call details" });
conversation.addAssistantMessage("text", "the second llm response");
Assert.withSoftAssertions(function (soft) {
soft.equal(conversation.messages.length, 7);
soft.equal(conversation.messages[0].turnIndex, 0);
soft.equal(conversation.messages[1].turnIndex, 0);
soft.equal(conversation.messages[2].turnIndex, 0);
soft.equal(conversation.messages[3].turnIndex, 0);
soft.equal(conversation.messages[4].turnIndex, 1);
soft.equal(conversation.messages[5].turnIndex, 1);
soft.equal(conversation.messages[6].turnIndex, 1);
});
});
add_task(function test_ChatConversation_getMessagesInOpenAiFormat() {
const conversation = new ChatConversation({});
conversation.addSystemMessage("text", "the system prompt");
conversation.addUserMessage("a user's prompt", "https://www.somesite.com");
conversation.addToolCallMessage({ some: "tool call details" });
conversation.addAssistantMessage("text", "the llm response");
conversation.addUserMessage("a user's second prompt", "some question");
conversation.addToolCallMessage({ some: "more tool call details" });
conversation.addAssistantMessage("text", "the second llm response");
const openAiFormat = conversation.getMessagesInOpenAiFormat();
Assert.deepEqual(openAiFormat, [
{ role: "system", content: "the system prompt" },
{ role: "user", content: "a user's prompt" },
{ role: "tool", content: { some: "tool call details" } },
{ role: "assistant", content: "the llm response" },
{ role: "user", content: "a user's second prompt" },
{ role: "tool", content: { some: "more tool call details" } },
{ role: "assistant", content: "the second llm response" },
]);
});