discourse-ai/assets/javascripts/discourse/components/ai-persona-list-editor.gjs
Sam 9f2a4094f5
FEATURE: persona/tool import and export (#1450)
Introduces import/export feature for tools and personas.

Uploads are omitted for now, and will be added in a future PR 

*   **Backend:**
    *   Adds `import` and `export` actions to `Admin::AiPersonasController` and `Admin::AiToolsController`.
    *   Introduces `DiscourseAi::PersonaExporter` and `DiscourseAi::PersonaImporter` services to manage JSON serialization and deserialization.
    *   The export format for a persona embeds its associated custom tools. To ensure portability, `AiTool` references are serialized using their `tool_name` rather than their internal database `id`.
    *   The import logic detects conflicts by name. A `force=true` parameter can be passed to overwrite existing records.

*   **Frontend:**
    *   `AiPersonaListEditor` and `AiToolListEditor` components now include an "Import" button that handles file selection and POSTs the JSON data to the respective `import` endpoint.
    *   `AiPersonaEditorForm` and `AiToolEditorForm` components feature an "Export" button that triggers a download of the serialized record.
    *   Handles import conflicts (HTTP `409` for tools, `422` for personas) by showing a `dialog.confirm` prompt to allow the user to force an overwrite.

*   **Testing:**
    *   Adds comprehensive request specs for the new controller actions (`#import`, `#export`).
    *   Includes unit specs for the `PersonaExporter` and `PersonaImporter` services.
* Persona import and export implemented
2025-06-24 12:41:10 +10:00

430 lines
14 KiB
Text

import Component from "@glimmer/component";
import { tracked } from "@glimmer/tracking";
import { concat, fn, hash } from "@ember/helper";
import { action } from "@ember/object";
import { LinkTo } from "@ember/routing";
import { service } from "@ember/service";
import { gt } from "truth-helpers";
import DBreadcrumbsItem from "discourse/components/d-breadcrumbs-item";
import DButton from "discourse/components/d-button";
import DPageSubheader from "discourse/components/d-page-subheader";
import DSelect from "discourse/components/d-select";
import DropdownMenu from "discourse/components/dropdown-menu";
import FilterInput from "discourse/components/filter-input";
import avatar from "discourse/helpers/avatar";
import concatClass from "discourse/helpers/concat-class";
import icon from "discourse/helpers/d-icon";
import { ajax } from "discourse/lib/ajax";
import { popupAjaxError } from "discourse/lib/ajax-error";
import { i18n } from "discourse-i18n";
import AdminConfigAreaEmptyList from "admin/components/admin-config-area-empty-list";
import DMenu from "float-kit/components/d-menu";
import AiPersona from "../admin/models/ai-persona";
import AiPersonaEditor from "./ai-persona-editor";
const LAYOUT_BUTTONS = [
{
id: "table",
label: "discourse_ai.layout.table",
icon: "discourse-table",
},
{
id: "card",
label: "discourse_ai.layout.card",
icon: "table",
},
];
export default class AiPersonaListEditor extends Component {
@service adminPluginNavManager;
@service keyValueStore;
@service capabilities;
@service dialog;
@tracked filterValue = "";
@tracked featureFilter = "all";
@tracked currentLayout = LAYOUT_BUTTONS[0];
constructor() {
super(...arguments);
const savedLayoutId = this.keyValueStore.get("ai-persona-list-layout");
if (savedLayoutId) {
const found = LAYOUT_BUTTONS.find((b) => b.id === savedLayoutId);
if (found) {
this.currentLayout = found;
}
}
}
get filteredPersonas() {
let personas = this.args.personas || [];
// Filter by feature if not "all"
if (this.featureFilter !== "all") {
personas = personas.filter((persona) =>
(persona.features || []).some(
(feature) => feature.module_name === this.featureFilter
)
);
}
// Filter by search term if present
if (this.filterValue) {
const term = this.filterValue.toLowerCase();
personas = personas.filter((persona) => {
const textMatches =
persona.name?.toLowerCase().includes(term) ||
persona.description?.toLowerCase().includes(term);
const featureMatches = (persona.features || []).some((feature) =>
feature.module_name?.toLowerCase().includes(term)
);
const llmMatches = persona.default_llm?.display_name
?.toLowerCase()
.includes(term);
return textMatches || featureMatches || llmMatches;
});
}
return personas;
}
get featureFilterOptions() {
let features = [];
(this.args.personas || []).forEach((persona) => {
(persona.features || []).forEach((feature) => {
if (feature?.module_name && !features.includes(feature.module_name)) {
features.push(feature.module_name);
}
});
});
features.sort();
return [
{
value: "all",
label: i18n("discourse_ai.ai_persona.filters.all_features"),
},
...features.map((name) => ({
value: name,
label: i18n(`discourse_ai.features.${name}.name`),
})),
];
}
@action
async toggleEnabled(persona) {
const oldValue = persona.enabled;
const newValue = !oldValue;
try {
persona.set("enabled", newValue);
await persona.save();
} catch (err) {
persona.set("enabled", oldValue);
popupAjaxError(err);
}
}
@action
onNameFilterChange(event) {
this.filterValue = event.target?.value || "";
}
@action
onFeatureFilterChange(value) {
this.featureFilter = value;
}
@action
resetAndFocus() {
this.filterValue = "";
this.featureFilter = "all";
document.querySelector(".admin-filter__input").focus();
}
@action
onRegisterApi(api) {
this.dMenu = api;
}
@action
onLayoutSelect(layoutId) {
const found = LAYOUT_BUTTONS.find((b) => b.id === layoutId);
if (found) {
this.currentLayout = found;
this.keyValueStore.set({
key: "ai-persona-list-layout",
value: layoutId,
});
}
this.dMenu.close();
}
@action
importPersona() {
const fileInput = document.createElement("input");
fileInput.type = "file";
fileInput.accept = ".json";
fileInput.style.display = "none";
fileInput.onchange = (event) => this.handleFileSelect(event);
document.body.appendChild(fileInput);
fileInput.click();
document.body.removeChild(fileInput);
}
@action
handleFileSelect(event) {
const file = event.target.files[0];
if (!file) {
return;
}
const reader = new FileReader();
reader.onload = (e) => {
try {
const json = JSON.parse(e.target.result);
this.uploadPersona(json);
} catch {
this.dialog.alert(
i18n("discourse_ai.ai_persona.import_error_not_json")
);
}
};
reader.readAsText(file);
}
uploadPersona(personaData, force = false) {
let url = `/admin/plugins/discourse-ai/ai-personas/import.json`;
const payload = personaData;
if (force) {
payload.force = true;
}
return ajax(url, {
type: "POST",
data: JSON.stringify(payload),
contentType: "application/json",
})
.then((result) => {
let persona = AiPersona.create(result);
let existingPersona = this.args.personas.findBy("id", persona.id);
if (existingPersona) {
this.args.personas.removeObject(existingPersona);
}
this.args.personas.insertAt(0, persona);
})
.catch((error) => {
if (error.jqXHR?.status === 422) {
this.dialog.confirm({
message:
i18n("discourse_ai.ai_persona.import_error_conflict", {
name: personaData.persona.name,
}) +
"\n" +
error.jqXHR.responseJSON?.errors?.join("\n"),
confirmButtonLabel: "discourse_ai.ai_persona.overwrite",
didConfirm: () => this.uploadPersona(personaData, true),
});
} else {
popupAjaxError(error);
}
});
}
<template>
<DBreadcrumbsItem
@path="/admin/plugins/{{this.adminPluginNavManager.currentPlugin.name}}/ai-personas"
@label={{i18n "discourse_ai.ai_persona.short_title"}}
/>
<section class="ai-persona-list-editor__current admin-detail">
{{#if @currentPersona}}
<AiPersonaEditor @model={{@currentPersona}} @personas={{@personas}} />
{{else}}
<DPageSubheader
@titleLabel={{i18n "discourse_ai.ai_persona.short_title"}}
@descriptionLabel={{i18n
"discourse_ai.ai_persona.persona_description"
}}
@learnMoreUrl="https://meta.discourse.org/t/ai-bot-personas/306099"
>
<:actions as |actions|>
<actions.Default
@label="discourse_ai.ai_persona.import"
@action={{this.importPersona}}
@icon="upload"
class="ai-persona-list-editor__import-button"
/>
<actions.Primary
@label="discourse_ai.ai_persona.new"
@route="adminPlugins.show.discourse-ai-personas.new"
@icon="plus"
class="ai-persona-list-editor__new-button"
/>
</:actions>
</DPageSubheader>
{{#if @personas}}
<div class="ai-persona-list-editor__controls">
<FilterInput
placeholder={{i18n "discourse_ai.ai_persona.filters.text"}}
@filterAction={{this.onNameFilterChange}}
@value={{this.filterValue}}
class="admin-filter__input"
@icons={{hash left="magnifying-glass"}}
/>
<DSelect
@value={{this.featureFilter}}
@includeNone={{false}}
@onChange={{this.onFeatureFilterChange}}
as |select|
>
{{#each this.featureFilterOptions as |option|}}
<select.Option @value={{option.value}}>
{{option.label}}
</select.Option>
{{/each}}
</DSelect>
{{#if this.capabilities.viewport.md}}
<DMenu
@modalForMobile={{true}}
@autofocus={{true}}
@identifier="persona-list-layout"
@onRegisterApi={{this.onRegisterApi}}
@triggerClass="btn-default btn-icon"
>
<:trigger>
{{icon this.currentLayout.icon}}
</:trigger>
<:content>
<DropdownMenu as |dropdown|>
{{#each LAYOUT_BUTTONS as |button|}}
<dropdown.item>
<DButton
@label={{button.label}}
@icon={{button.icon}}
class="btn-transparent"
@action={{fn this.onLayoutSelect button.id}}
/>
</dropdown.item>
{{/each}}
</DropdownMenu>
</:content>
</DMenu>
{{/if}}
</div>
{{else}}
<AdminConfigAreaEmptyList
@ctaLabel="discourse_ai.ai_persona.new"
@ctaRoute="adminPlugins.show.discourse-ai-personas.new"
@ctaClass="ai-persona-list-editor__empty-new-button"
@emptyLabel="discourse_ai.ai_persona.no_personas"
/>
{{/if}}
{{#if this.filteredPersonas}}
<table
class={{concatClass
"content-list ai-persona-list-editor d-admin-table"
(concat "--layout-" this.currentLayout.id)
}}
>
<thead>
<tr>
<th>{{i18n "discourse_ai.ai_persona.name"}}</th>
<th>{{i18n "discourse_ai.llms.short_title"}}</th>
<th>{{i18n "discourse_ai.features.short_title"}}</th>
</tr>
</thead>
<tbody>
{{#each this.filteredPersonas as |persona|}}
<tr
data-persona-id={{persona.id}}
class={{concatClass
"ai-persona-list__row d-admin-row__content"
(if persona.priority "--priority")
(if persona.enabled "--enabled")
}}
>
<td class="d-admin-row__overview">
<div class="ai-persona-list__name-with-description">
<h3 class="ai-persona-list__name">
{{#if persona.user}}
{{avatar persona.user imageSize="tiny"}}
{{/if}}
{{persona.name}}
</h3>
<div class="ai-persona-list__description">
{{persona.description}}
</div>
</div>
</td>
<td class="d-admin-row__llms">
{{#if persona.default_llm}}
<span class="--card-label">
{{i18n "discourse_ai.ai_persona.llms_list"}}
</span>
<DButton
class="btn-flat btn-small ai-persona-list__row-item-feature"
@translatedLabel={{persona.default_llm.display_name}}
@route="adminPlugins.show.discourse-ai-llms.edit"
@routeModels={{persona.default_llm.id}}
/>
{{/if}}
</td>
<td class="d-admin-row__features">
{{#if persona.features.length}}
<span class="--card-label">
{{i18n
"discourse_ai.ai_persona.features_list"
count=persona.features.length
}}
</span>
{{#each persona.features as |feature index|}}
<span class="d-admin-row__row-feature-list">
{{#if (gt index 0)}}, {{/if}}
<DButton
class="btn-flat btn-small ai-persona-list__row-item-feature"
@translatedLabel={{i18n
(concat
"discourse_ai.features."
feature.module_name
".name"
)
}}
@route="adminPlugins.show.discourse-ai-features.edit"
@routeModels={{feature.id}}
/>
</span>
{{/each}}
{{/if}}
</td>
<td class="d-admin-row__controls">
<LinkTo
@route="adminPlugins.show.discourse-ai-personas.edit"
@model={{persona}}
class="btn btn-text btn-small"
>{{i18n "discourse_ai.ai_persona.edit"}} </LinkTo>
</td>
</tr>
{{/each}}
</tbody>
</table>
{{else}}
<div class="ai-persona-list-editor__no-results">
<h3>{{i18n "discourse_ai.ai_persona.filters.no_results"}}</h3>
<DButton
@icon="arrow-rotate-left"
@label="discourse_ai.ai_persona.filters.reset"
@action={{this.resetAndFocus}}
class="btn-default"
/>
</div>
{{/if}}
{{/if}}
</section>
</template>
}