Skip to content

A platform for community discussion. Free, open, simple.

UX: Use cards and FormKit on the Data Explorer new and edit query pages (#45001)

David Battersbyce0a7711575d
diff --git a/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/edit.gjs b/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/edit.gjs
index 0bcf6477f0c..4ee02b2f40b 100644
--- a/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/edit.gjs
+++ b/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/edit.gjs
@@ -1,6 +1,7 @@
import Component from "@glimmer/component";
import { on } from "@ember/modifier";
import didInsert from "@ember/render-modifiers/modifiers/did-insert";
+import AdminConfigAreaCard from "discourse/admin/components/admin-config-area-card";
import AceEditor from "discourse/components/ace-editor";
import BackButton from "discourse/components/back-button";
import DSegmentedControl from "discourse/components/d-segmented-control";
@@ -97,30 +98,37 @@ export default class QueriesEdit extends Component {
{{/if}}
{{#unless @controller.model.destroyed}}
- <div class="query-edit__metadata-fields">
- <div class="query-edit__metadata-field">
- <span class="query-edit__metadata-label">
- {{i18n "explorer.allow_groups"}}
- </span>
- <GroupChooser
- @content={{@controller.groupOptions}}
- @onChange={{@controller.updateGroupIds}}
- @value={{@controller.model.group_ids}}
- />
- </div>
+ <AdminConfigAreaCard
+ class="query-edit__details"
+ @heading="explorer.query_details"
+ >
+ <:content>
+ <div class="query-edit__metadata-fields">
+ <div class="query-edit__metadata-field">
+ <span class="query-edit__metadata-label">
+ {{i18n "explorer.allow_groups"}}
+ </span>
+ <GroupChooser
+ @content={{@controller.groupOptions}}
+ @onChange={{@controller.updateGroupIds}}
+ @value={{@controller.model.group_ids}}
+ />
+ </div>
- <div class="query-edit__metadata-field">
- <span class="query-edit__metadata-label">
- {{i18n "explorer.query_tags"}}
- </span>
- <QueryTagChooser
- @automaticTags={{@controller.model.automatic_tags}}
- @availableTags={{@controller.availableTags}}
- @onChange={{@controller.updateTags}}
- @value={{@controller.model.tags}}
- />
- </div>
- </div>
+ <div class="query-edit__metadata-field">
+ <span class="query-edit__metadata-label">
+ {{i18n "explorer.query_tags"}}
+ </span>
+ <QueryTagChooser
+ @automaticTags={{@controller.model.automatic_tags}}
+ @availableTags={{@controller.availableTags}}
+ @onChange={{@controller.updateTags}}
+ @value={{@controller.model.tags}}
+ />
+ </div>
+ </div>
+ </:content>
+ </AdminConfigAreaCard>
{{/unless}}
{{#if (eq @controller.mode "ai")}}
diff --git a/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/new.gjs b/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/new.gjs
index 6f849435c68..7ec14d9c102 100644
--- a/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/new.gjs
+++ b/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/new.gjs
@@ -1,14 +1,11 @@
-import { on } from "@ember/modifier";
+import AdminConfigAreaCard from "discourse/admin/components/admin-config-area-card";
import AceEditor from "discourse/components/ace-editor";
import BackButton from "discourse/components/back-button";
import DSegmentedControl from "discourse/components/d-segmented-control";
import Form from "discourse/components/form";
import GroupChooser from "discourse/select-kit/components/group-chooser";
-import { and, eq } from "discourse/truth-helpers";
-import DButton from "discourse/ui-kit/d-button";
+import { eq } from "discourse/truth-helpers";
import DConditionalLoadingSpinner from "discourse/ui-kit/d-conditional-loading-spinner";
-import DTextField from "discourse/ui-kit/d-text-field";
-import DTextarea from "discourse/ui-kit/d-textarea";
import dIcon from "discourse/ui-kit/helpers/d-icon";
import { i18n } from "discourse-i18n";
import ExplorerSchema from "discourse/plugins/discourse-data-explorer/discourse/components/explorer-schema";
@@ -32,257 +29,295 @@ export default <template>
{{/if}}
</div>
- <div class="query-new">
- {{#if (and @controller.aiQueriesEnabled (eq @controller.mode "ai"))}}
- <div class="query-new__ai-section">
- <label class="query-new__ai-label">
- <span>{{i18n "explorer.ai.description_title"}}</span>
- {{dIcon "discourse-sparkles"}}
- </label>
-
- <p class="query-new__ai-hint">
- {{i18n "explorer.ai.description_hint"}}
- </p>
-
- <DTextarea
- class="query-new__ai-textarea"
- disabled={{@controller.aiGenerating}}
- placeholder={{i18n "explorer.ai.description_placeholder"}}
- @value={{@controller.aiDescription}}
- {{on "input" @controller.updateAiDescription}}
- {{on "keydown" @controller.handleKeydown}}
- />
-
- <div class="query-new__ai-actions">
- {{#if @controller.hasGenerated}}
- <DButton
- class="btn-default query-new__regenerate-btn"
- @action={{@controller.generate}}
- @disabled={{@controller.aiGenerating}}
- @icon="discourse-sparkles"
- @label="explorer.ai.regenerate"
- />
- {{else}}
- <DButton
- class="btn-primary query-new__generate-btn"
- @action={{@controller.generate}}
- @disabled={{@controller.aiGenerating}}
- @label="explorer.ai.generate"
- />
- {{/if}}
-
- {{#if @controller.aiGenerating}}
- <span class="query-new__generating-indicator">
- <DConditionalLoadingSpinner @condition={{true}} @size="small" />
- <span>{{i18n "explorer.ai.generating"}}</span>
- </span>
- {{/if}}
- </div>
- </div>
-
- {{#if @controller.hasGenerated}}
- <hr class="query-new__divider" />
-
- <div class="query-new__result-bar">
- {{#if @controller.previewSucceeded}}
- <div class="query-new__result-about">
- {{@controller.previewResultCount}}
- {{@controller.previewDuration}}
- </div>
- {{/if}}
-
- <DSegmentedControl
- class="query-results-modes"
- @items={{@controller.viewItems}}
- @name="query-result-view"
- @onSelect={{@controller.setView}}
- @translatedLabel={{i18n "explorer.view.label"}}
- @value={{@controller.view}}
- />
- </div>
+ {{! the header block only renders in AI mode, when @heading is unset }}
+ <AdminConfigAreaCard
+ @heading={{unless @controller.isAiMode "explorer.new_query"}}
+ >
+ <:header>
+ <span class="query-new__ai-heading" id="query-new-ai-heading">
+ {{i18n "explorer.ai.description_title"}}
+ {{dIcon "discourse-sparkles"}}
+ </span>
+ </:header>
+ <:content>
+ <div class="query-new">
+ {{#if @controller.isAiMode}}
+ <div class="query-new__ai-section">
+ <Form
+ class="query-new__ai-form"
+ @data={{@controller.aiPromptData}}
+ @onRegisterApi={{@controller.registerAiPromptApi}}
+ @onSubmit={{@controller.generate}}
+ as |form|
+ >
+ <form.Field
+ @description={{i18n "explorer.ai.description_hint"}}
+ @disabled={{@controller.aiGenerating}}
+ @format="full"
+ @name="prompt"
+ @showTitle={{false}}
+ @title={{i18n "explorer.ai.description_title"}}
+ @type="textarea"
+ @validation="required"
+ as |field|
+ >
+ <field.Control
+ aria-labelledby="query-new-ai-heading"
+ placeholder={{i18n "explorer.ai.description_placeholder"}}
+ />
+ </form.Field>
+ <form.Actions>
+ {{#if @controller.hasGenerated}}
+ <form.Button
+ class="btn-default query-new__regenerate-btn"
+ @action={{@controller.submitAiPrompt}}
+ @disabled={{@controller.aiGenerating}}
+ @icon="discourse-sparkles"
+ @label="explorer.ai.regenerate"
+ />
+ {{else}}
+ <form.Submit
+ class="query-new__generate-btn"
+ @disabled={{@controller.aiGenerating}}
+ @label="explorer.ai.generate"
+ />
+ {{/if}}
- {{#if (eq @controller.view "sql")}}
- <div class="query-new__sql-editor">
- <AceEditor
- @content={{@controller.generatedSql}}
- @mode="sql"
- @onChange={{@controller.updateSql}}
- @resizable={{true}}
- />
- </div>
- {{else}}
- <div class="query-new__preview query-results">
- {{#if @controller.previewLoading}}
- <DConditionalLoadingSpinner @condition={{true}} />
- {{else if @controller.previewSucceeded}}
- <QueryResult
- @content={{@controller.previewResults}}
- @hideHeaderActions={{true}}
- @onSetView={{@controller.setView}}
- @showDownloads={{false}}
- @view={{@controller.view}}
- />
- {{else if @controller.showPreview}}
- {{#each @controller.previewResults.errors as |err|}}
- <pre class="query-error"><code>{{~err}}</code></pre>
- {{/each}}
- {{/if}}
+ {{#if @controller.aiGenerating}}
+ <span class="query-new__generating-indicator">
+ <DConditionalLoadingSpinner
+ @condition={{true}}
+ @size="small"
+ />
+ <span>{{i18n "explorer.ai.generating"}}</span>
+ </span>
+ {{/if}}
+ </form.Actions>
+ </Form>
</div>
- {{/if}}
- <div class="query-new__fields">
- <label class="query-new__field-label">
- {{i18n "explorer.query_name"}}
- </label>
- <DTextField
- class="query-new__name-input"
- @onChange={{@controller.updateName}}
- @value={{@controller.generatedName}}
- />
+ {{#if @controller.hasGenerated}}
+ <hr class="query-new__divider" />
- <label class="query-new__field-label">
- {{i18n "explorer.query_description"}}
- <span class="query-new__optional">
- ({{i18n "explorer.ai.optional"}})
- </span>
- </label>
- <DTextarea
- class="query-new__description-input"
- @value={{@controller.generatedDescription}}
- {{on "input" @controller.updateDescription}}
- />
+ <div class="query-new__result-bar">
+ {{#if @controller.previewSucceeded}}
+ <div class="query-new__result-about">
+ {{@controller.previewResultCount}}
+ {{@controller.previewDuration}}
+ </div>
+ {{/if}}
- <div class="query-new__access-fields">
- <div class="query-new__access-field">
- <label class="query-new__field-label">
- {{i18n "explorer.allow_groups"}}
- </label>
- <GroupChooser
- class="query-group-select"
- @content={{@controller.groupOptions}}
- @onChange={{@controller.updateAiGroupIds}}
- @value={{@controller.aiGroupIds}}
+ <DSegmentedControl
+ class="query-results-modes"
+ @items={{@controller.viewItems}}
+ @name="query-result-view"
+ @onSelect={{@controller.setView}}
+ @translatedLabel={{i18n "explorer.view.label"}}
+ @value={{@controller.view}}
/>
</div>
- <div class="query-new__access-field">
- <label class="query-new__field-label">
- {{i18n "explorer.query_tags"}}
- </label>
- <QueryTagChooser
- @availableTags={{@controller.availableTags}}
- @onChange={{@controller.updateAiTags}}
- @value={{@controller.aiTags}}
- />
- </div>
- </div>
- </div>
+ {{#if (eq @controller.view "sql")}}
+ <div class="query-new__sql-editor">
+ <AceEditor
+ @content={{@controller.generatedSql}}
+ @mode="sql"
+ @onChange={{@controller.updateSql}}
+ @resizable={{true}}
+ />
+ </div>
+ {{else}}
+ <div class="query-new__preview query-results">
+ {{#if @controller.previewLoading}}
+ <DConditionalLoadingSpinner @condition={{true}} />
+ {{else if @controller.previewSucceeded}}
+ <QueryResult
+ @content={{@controller.previewResults}}
+ @hideHeaderActions={{true}}
+ @onSetView={{@controller.setView}}
+ @showDownloads={{false}}
+ @view={{@controller.view}}
+ />
+ {{else if @controller.showPreview}}
+ {{#each @controller.previewResults.errors as |err|}}
+ <pre class="query-error"><code>{{~err}}</code></pre>
+ {{/each}}
+ {{/if}}
+ </div>
+ {{/if}}
- <div class="query-new__actions">
- <DButton
- class="btn-default query-new__run-btn"
- @action={{@controller.runPreview}}
- @disabled={{@controller.previewDisabled}}
- @icon="play"
- @label="explorer.run"
- />
- <DButton
- class="btn-primary query-new__save-btn"
- @action={{@controller.saveQuery}}
- @disabled={{@controller.aiGenerating}}
- @label="explorer.ai.save_query"
- />
- </div>
- {{/if}}
- {{else}}
- <Form
- class="query-new__manual-form"
- @data={{@controller.manualFormData}}
- @onSubmit={{@controller.create}}
- as |form|
- >
- <form.Field
- @format="full"
- @name="name"
- @title={{i18n "explorer.query_name"}}
- @type="input"
- @validation="required"
- as |field|
- >
- <field.Control />
- </form.Field>
- <form.Field
- @format="full"
- @name="description"
- @title={{i18n "explorer.query_description"}}
- @type="textarea"
- as |field|
- >
- <field.Control />
- </form.Field>
- <form.Row as |row|>
- <row.Col @size={{6}}>
+ <Form
+ class="query-new__fields"
+ @data={{@controller.aiFormData}}
+ @onRegisterApi={{@controller.registerAiFormApi}}
+ @onSubmit={{@controller.saveQuery}}
+ as |form|
+ >
+ <form.Field
+ @format="full"
+ @name="name"
+ @title={{i18n "explorer.name"}}
+ @type="input"
+ @validation="required"
+ as |field|
+ >
+ <field.Control />
+ </form.Field>
+ <form.Field
+ @format="full"
+ @name="description"
+ @title={{i18n "explorer.query_description"}}
+ @type="textarea"
+ as |field|
+ >
+ <field.Control />
+ </form.Field>
+ <form.Row as |row|>
+ <row.Col @size={{6}}>
+ <form.Field
+ @format="full"
+ @name="groupIds"
+ @title={{i18n "explorer.allow_groups"}}
+ @type="custom"
+ as |field|
+ >
+ <field.Control>
+ <GroupChooser
+ class="query-group-select"
+ @content={{@controller.groupOptions}}
+ @onChange={{field.set}}
+ @value={{field.value}}
+ />
+ </field.Control>
+ </form.Field>
+ </row.Col>
+ <row.Col @size={{6}}>
+ <form.Field
+ @format="full"
+ @name="tags"
+ @title={{i18n "explorer.query_tags"}}
+ @type="custom"
+ as |field|
+ >
+ <field.Control>
+ <QueryTagChooser
+ @availableTags={{@controller.availableTags}}
+ @onChange={{field.set}}
+ @value={{field.value}}
+ />
+ </field.Control>
+ </form.Field>
+ </row.Col>
+ </form.Row>
+ <form.Actions>
+ <form.Button
+ class="btn-default query-new__run-btn"
+ @action={{@controller.runPreview}}
+ @disabled={{@controller.previewDisabled}}
+ @icon="play"
+ @label="explorer.run"
+ />
+ <form.Submit
+ class="query-new__save-btn"
+ @disabled={{@controller.aiGenerating}}
+ @label="explorer.ai.save_query"
+ />
+ </form.Actions>
+ </Form>
+ {{/if}}
+ {{else}}
+ <Form
+ class="query-new__manual-form"
+ @data={{@controller.manualFormData}}
+ @onSubmit={{@controller.create}}
+ as |form|
+ >
<form.Field
@format="full"
- @name="groupIds"
- @title={{i18n "explorer.allow_groups"}}
- @type="custom"
+ @name="name"
+ @title={{i18n "explorer.name"}}
+ @type="input"
+ @validation="required"
as |field|
>
- <field.Control>
- <GroupChooser
- class="query-group-select"
- @content={{@controller.groupOptions}}
- @onChange={{field.set}}
- @value={{field.value}}
- />
- </field.Control>
+ <field.Control />
</form.Field>
- </row.Col>
- <row.Col @size={{6}}>
<form.Field
@format="full"
- @name="tags"
- @title={{i18n "explorer.query_tags"}}
- @type="custom"
+ @name="description"
+ @title={{i18n "explorer.query_description"}}
+ @type="textarea"
as |field|
>
- <field.Control>
- <QueryTagChooser
- @availableTags={{@controller.availableTags}}
- @onChange={{field.set}}
- @value={{field.value}}
- />
- </field.Control>
+ <field.Control />
</form.Field>
- </row.Col>
- </form.Row>
- <label class="query-new__sql-label">
- {{i18n "explorer.ai.sql_label"}}
- </label>
- <div class="query-editor {{if @controller.hideSchema 'no-schema'}}">
- <div class="panels-flex">
- <div class="editor-panel">
- <AceEditor
- @content={{@controller.manualSql}}
- @mode="sql"
- @onChange={{@controller.updateManualSql}}
- />
- </div>
- <div class="right-panel">
- <ExplorerSchema
- @hideSchema={{@controller.hideSchema}}
- @schema={{@controller.schema}}
- @updateHideSchema={{@controller.updateHideSchema}}
- />
+ <form.Row as |row|>
+ <row.Col @size={{6}}>
+ <form.Field
+ @format="full"
+ @name="groupIds"
+ @title={{i18n "explorer.allow_groups"}}
+ @type="custom"
+ as |field|
+ >
+ <field.Control>
+ <GroupChooser
+ class="query-group-select"
+ @content={{@controller.groupOptions}}
+ @onChange={{field.set}}
+ @value={{field.value}}
+ />
+ </field.Control>
+ </form.Field>
+ </row.Col>
+ <row.Col @size={{6}}>
+ <form.Field
+ @format="full"
+ @name="tags"
+ @title={{i18n "explorer.query_tags"}}
+ @type="custom"
+ as |field|
+ >
+ <field.Control>
+ <QueryTagChooser
+ @availableTags={{@controller.availableTags}}
+ @onChange={{field.set}}
+ @value={{field.value}}
+ />
+ </field.Control>
+ </form.Field>
+ </row.Col>
+ </form.Row>
+ <label class="query-new__sql-label">
+ {{i18n "explorer.ai.sql_label"}}
+ </label>
+ <div
+ class="query-editor {{if @controller.hideSchema 'no-schema'}}"
+ >
+ <div class="panels-flex">
+ <div class="editor-panel">
+ <AceEditor
+ @content={{@controller.manualSql}}
+ @mode="sql"
+ @onChange={{@controller.updateManualSql}}
+ />
+ </div>
+ <div class="right-panel">
+ <ExplorerSchema
+ @hideSchema={{@controller.hideSchema}}
+ @schema={{@controller.schema}}
+ @updateHideSchema={{@controller.updateHideSchema}}
+ />
+ </div>
+ </div>
</div>
- </div>
- </div>
- <form.Actions>
- <form.Submit @icon="plus" @label="explorer.create" />
- </form.Actions>
- </Form>
- {{/if}}
- </div>
+ <form.Actions>
+ <form.Submit @icon="plus" @label="explorer.create" />
+ </form.Actions>
+ </Form>
+ {{/if}}
+ </div>
+ </:content>
+ </AdminConfigAreaCard>
</div>
</template>
diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/new.js b/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/new.js
index 5446fd92038..cdc27e6ab34 100644
--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/new.js
+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/new.js
@@ -27,24 +27,23 @@ export default class AdminPluginsExplorerNew extends Controller {
@tracked loading = false;
@tracked aiGenerating = false;
@tracked hasGenerated = false;
- @tracked aiDescription = "";
@tracked generatedSql = "";
- @tracked generatedName = "";
- @tracked generatedDescription = "";
@tracked mode = rememberedMode() ?? "ai";
@tracked schema = null;
@tracked groups = null;
@tracked availableTags = [];
- @tracked aiGroupIds = [];
- @tracked aiTags = [];
@tracked hideSchema = dataExplorerStore.get(HIDE_SCHEMA_KEY) === "true";
@tracked manualSql = "SELECT 1";
@tracked previewLoading = false;
@tracked previewResults = null;
@tracked showPreview = false;
@tracked view = "sql";
+ @tracked aiPromptData = { prompt: "" };
+ @tracked aiFormData = null;
manualFormData = { name: "", description: "", groupIds: [], tags: [] };
+ #aiPromptApi = null;
+ #aiFormApi = null;
_teardownAiGeneration = null;
get previewDisabled() {
@@ -98,21 +97,33 @@ export default class AdminPluginsExplorerNew extends Controller {
return dataExplorerAiQueriesEnabled(this.siteSettings);
}
+ get isAiMode() {
+ return this.aiQueriesEnabled && this.mode === "ai";
+ }
+
@action
setView(value) {
this.view = value;
}
@action
- handleKeydown(event) {
- if (event.key === "Enter" && (event.metaKey || event.ctrlKey)) {
- event.preventDefault();
- this.generate();
+ setMode(value) {
+ // the AI forms unmount in manual mode, so keep their edits for when they return
+ if (this.mode === "ai" && this.#aiPromptApi) {
+ this.aiPromptData = { prompt: this.#aiPromptApi.get("prompt") };
+ this.#aiPromptApi = null;
+ }
+
+ if (this.mode === "ai" && this.#aiFormApi) {
+ this.aiFormData = {
+ name: this.#aiFormApi.get("name"),
+ description: this.#aiFormApi.get("description"),
+ groupIds: this.#aiFormApi.get("groupIds"),
+ tags: this.#aiFormApi.get("tags"),
+ };
+ this.#aiFormApi = null;
}
- }
- @action
- setMode(value) {
this.mode = value;
rememberMode(value);
}
@@ -129,13 +140,18 @@ export default class AdminPluginsExplorerNew extends Controller {
}
@action
- updateAiGroupIds(value) {
- this.aiGroupIds = value;
+ registerAiPromptApi(api) {
+ this.#aiPromptApi = api;
+ }
+
+ @action
+ submitAiPrompt() {
+ this.#aiPromptApi?.submit();
}
@action
- updateAiTags(value) {
- this.aiTags = value;
+ registerAiFormApi(api) {
+ this.#aiFormApi = api;
}
@action
@@ -166,8 +182,8 @@ export default class AdminPluginsExplorerNew extends Controller {
}
@action
- async generate() {
- if (this.aiGenerating || !this.aiDescription.trim()) {
+ async generate({ prompt }) {
+ if (this.aiGenerating) {
return;
}
@@ -182,7 +198,7 @@ export default class AdminPluginsExplorerNew extends Controller {
{
type: "POST",
data: {
- ai_description: this.aiDescription.trim(),
+ ai_description: prompt.trim(),
existing_sql: this.generatedSql || undefined,
},
}
@@ -193,8 +209,7 @@ export default class AdminPluginsExplorerNew extends Controller {
generationId: response.generation_id,
onComplete: (data) => {
this.generatedSql = data.sql;
- this.generatedName = data.name;
- this.generatedDescription = data.description;
+ this.#applyGeneratedDetails(data);
this.hasGenerated = true;
this.aiGenerating = false;
// prioritise the result: run straight away so the data is what the
@@ -238,7 +253,7 @@ export default class AdminPluginsExplorerNew extends Controller {
type: "POST",
data: {
sql: this.generatedSql,
- name: this.generatedName || undefined,
+ name: this.#aiFormApi?.get("name") || undefined,
},
}
);
@@ -260,16 +275,16 @@ export default class AdminPluginsExplorerNew extends Controller {
}
@action
- async saveQuery() {
+ async saveQuery({ name, description, groupIds, tags }) {
try {
this.loading = true;
const result = await this.store
.createRecord("query", {
- name: this.generatedName,
- description: this.generatedDescription,
+ name: name.trim(),
+ description: description?.trim(),
sql: this.generatedSql,
- group_ids: this.aiGroupIds,
- tags: this.aiTags,
+ group_ids: groupIds,
+ tags,
})
.save();
this.toasts.success({
@@ -286,40 +301,24 @@ export default class AdminPluginsExplorerNew extends Controller {
}
}
- @action
- updateAiDescription(event) {
- this.aiDescription = event.target.value;
- }
-
@action
updateSql(newSql) {
this.generatedSql = newSql;
}
- @action
- updateName(value) {
- this.generatedName = value;
- }
-
- @action
- updateDescription(event) {
- this.generatedDescription = event.target.value;
- }
-
resetState() {
this._teardownAi();
this.aiGenerating = false;
this.hasGenerated = false;
- this.aiDescription = "";
+ this.aiPromptData = { prompt: "" };
+ this.#aiPromptApi = null;
this.generatedSql = "";
- this.generatedName = "";
- this.generatedDescription = "";
+ this.aiFormData = null;
+ this.#aiFormApi = null;
this.mode = rememberedMode() ?? "ai";
this.schema = null;
this.groups = null;
this.availableTags = [];
- this.aiGroupIds = [];
- this.aiTags = [];
this.hideSchema = dataExplorerStore.get(HIDE_SCHEMA_KEY) === "true";
this.manualSql = "SELECT 1";
this.loading = false;
@@ -335,6 +334,24 @@ export default class AdminPluginsExplorerNew extends Controller {
this.view = "sql";
}
+ // A regenerate updates the mounted form in place, committing so the new
+ // values don't count as unsaved edits.
+ async #applyGeneratedDetails({ name, description }) {
+ const formApi = this.#aiFormApi;
+ if (formApi) {
+ await formApi.setProperties({ name, description });
+ formApi.commit();
+ } else {
+ this.aiFormData = {
+ groupIds: [],
+ tags: [],
+ ...this.aiFormData,
+ name,
+ description,
+ };
+ }
+ }
+
_teardownAi() {
this._teardownAiGeneration?.();
this._teardownAiGeneration = null;
diff --git a/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss b/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss
index 1975fd2f33d..91c4faccd87 100644
--- a/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss
+++ b/plugins/discourse-data-explorer/assets/stylesheets/explorer.scss
@@ -369,11 +369,14 @@ table.group-reports {
white-space: pre-wrap;
}
+ &__details {
+ margin: 10px 0;
+ }
+
&__metadata-fields {
display: flex;
flex-wrap: wrap;
gap: var(--space-4);
- margin: 10px 0;
}
&__metadata-field {
@@ -580,37 +583,18 @@ table.group-reports {
}
}
+.query-new__ai-heading {
+ display: inline-flex;
+ align-items: center;
+ gap: 0.35em;
+}
+
.query-new {
.query-new__ai-section {
max-width: 720px;
margin-bottom: 1em;
}
- .query-new__ai-label {
- display: flex;
- align-items: center;
- gap: 0.35em;
- font-weight: 700;
- margin-bottom: 0.25em;
- }
-
- .query-new__ai-hint {
- color: var(--primary-medium);
- margin-bottom: 0.75em;
- }
-
- .query-new__ai-textarea {
- width: 100%;
- min-height: 3em;
- margin-bottom: 0.75em;
- }
-
- .query-new__ai-actions {
- display: flex;
- align-items: center;
- gap: 0.5em;
- }
-
.query-new__generating-indicator {
display: inline-flex;
align-items: center;
@@ -660,59 +644,15 @@ table.group-reports {
margin-top: 1.5em;
}
- .query-new__access-fields {
- display: flex;
- flex-wrap: wrap;
- gap: var(--space-4);
- margin-top: 1em;
- }
-
- .query-new__access-field {
- flex: 1 1 15rem;
- min-width: 0;
- }
-
.query-new__preview {
margin-top: 0.5em;
}
- .query-new__field-label {
- display: block;
- font-weight: 700;
- margin-bottom: 0.35em;
- margin-top: 1em;
-
- &:first-child {
- margin-top: 0;
- }
-
- .query-new__optional {
- font-weight: 400;
- color: var(--primary-medium);
- }
- }
-
- .query-new__name-input {
- width: 100%;
- margin-bottom: 0;
- }
-
- .query-new__description-input {
- width: 100%;
- min-height: 60px;
- }
-
.query-group-select,
.query-tag-chooser {
width: 100%;
}
- .query-new__actions {
- display: flex;
- gap: 0.5em;
- margin-top: 1em;
- }
-
.query-new__sql-label {
display: block;
font-weight: 700;
diff --git a/plugins/discourse-data-explorer/config/locales/client.en.yml b/plugins/discourse-data-explorer/config/locales/client.en.yml
index 13bfa8d5875..5e1e421d0da 100644
--- a/plugins/discourse-data-explorer/config/locales/client.en.yml
+++ b/plugins/discourse-data-explorer/config/locales/client.en.yml
@@ -27,6 +27,7 @@ en:
view_query: "View"
queries: "Queries"
back_to_queries: "Back to queries"
+ query_details: "Query details"
query_created: "Query created!"
mode:
label: "Query authoring mode"
@@ -56,7 +57,6 @@ en:
save_query: "Save query"
write_manually: "Write SQL manually"
sql_label: "SQL"
- optional: "optional"
import:
label: "Import query"
unparseable_json: "Unparseable JSON file."
@@ -151,6 +151,7 @@ en:
max_result_count:
one: "Showing top %{count} result."
other: "Showing top %{count} results."
+ name: "Name"
query_name: "Query"
query_groups: "Groups"
query_tags: "Tags"
diff --git a/plugins/discourse-data-explorer/spec/system/ai_query_generation_spec.rb b/plugins/discourse-data-explorer/spec/system/ai_query_generation_spec.rb
index 079fbc7f9a4..97965fd24ed 100644
--- a/plugins/discourse-data-explorer/spec/system/ai_query_generation_spec.rb
+++ b/plugins/discourse-data-explorer/spec/system/ai_query_generation_spec.rb
@@ -47,8 +47,8 @@ RSpec.describe "Data Explorer AI query generation" do
visit("/admin/plugins/discourse-data-explorer/queries/new")
expect(page).to have_css(".query-mode-switch")
- expect(page).to have_css(".query-new__ai-label", text: "Generate with AI")
- expect(page).to have_css(".query-new__ai-textarea")
+ expect(page).to have_css(".query-new__ai-heading", text: "Generate with AI")
+ expect(page).to have_css(".query-new__ai-section [data-name='prompt'] textarea")
expect(page).to have_button("Generate")
end
diff --git a/plugins/discourse-data-explorer/test/javascripts/acceptance/new-query-test.js b/plugins/discourse-data-explorer/test/javascripts/acceptance/new-query-test.js
index f667ab59927..c8c54725df3 100644
--- a/plugins/discourse-data-explorer/test/javascripts/acceptance/new-query-test.js
+++ b/plugins/discourse-data-explorer/test/javascripts/acceptance/new-query-test.js
@@ -248,10 +248,13 @@ acceptance("New Query - AI", function (needs) {
});
const GENERATION_ID = "test-generation";
+ const PROMPT_INPUT = ".query-new__ai-section [data-name='prompt'] textarea";
let createParams;
+ let generateParams;
needs.hooks.beforeEach(() => {
createParams = null;
+ generateParams = null;
});
needs.pretender((server, helper) => {
@@ -291,8 +294,13 @@ acceptance("New Query - AI", function (needs) {
server.post(
"/admin/plugins/discourse-data-explorer/queries/generate.json",
- () =>
- helper.response({ generation_id: GENERATION_ID, status: "generating" })
+ (request) => {
+ generateParams = new URLSearchParams(request.requestBody);
+ return helper.response({
+ generation_id: GENERATION_ID,
+ status: "generating",
+ });
+ }
);
server.post(
@@ -358,7 +366,7 @@ acceptance("New Query - AI", function (needs) {
async function generate(prompt) {
await visit("/admin/plugins/discourse-data-explorer/queries/new");
- await fillIn(".query-new__ai-textarea", prompt);
+ await fillIn(PROMPT_INPUT, prompt);
await click(".query-new__generate-btn");
await publishToMessageBus(
`/discourse-data-explorer/queries/ai-generation/${GENERATION_ID}`,
@@ -389,6 +397,48 @@ acceptance("New Query - AI", function (needs) {
.doesNotExist("the AI generation form is hidden");
});
+ test("titles the card after the selected mode", async function (assert) {
+ await visit("/admin/plugins/discourse-data-explorer/queries/new");
+
+ assert
+ .dom(".admin-config-area-card__title")
+ .hasText("Generate with AI", "AI mode titles the card");
+
+ await click(".query-mode-switch input[value='manual']");
+
+ assert
+ .dom(".admin-config-area-card__title")
+ .hasText("New query", "manual mode titles the card");
+ });
+
+ test("requires a prompt before generating", async function (assert) {
+ await visit("/admin/plugins/discourse-data-explorer/queries/new");
+ await click(".query-new__generate-btn");
+
+ assert
+ .dom(".query-new__ai-section [data-name='prompt'] .form-kit__errors")
+ .exists("an empty prompt shows a validation error");
+ assert.strictEqual(generateParams, null, "nothing is generated");
+ });
+
+ test("regenerating sends the updated prompt", async function (assert) {
+ await generate("show me a value");
+
+ await fillIn(PROMPT_INPUT, "limit it to 5 rows");
+ await click(".query-new__regenerate-btn");
+
+ assert.strictEqual(
+ generateParams.get("ai_description"),
+ "limit it to 5 rows",
+ "the edited prompt is sent"
+ );
+ assert.strictEqual(
+ generateParams.get("existing_sql"),
+ "SELECT 23 AS my_value",
+ "the generated SQL is sent to be refined"
+ );
+ });
+
test("save query is the primary action and the result is shown first", async function (assert) {
await generate("show me a value");
@@ -469,4 +519,19 @@ acceptance("New Query - AI", function (needs) {
"does not run the saved query before parameters can be adjusted"
);
});
+
+ test("keeps edits to a generated query across a mode switch", async function (assert) {
+ await generate("show me a value");
+
+ await fillIn(".query-new__fields [data-name='name'] input", "Edited name");
+ await click(".query-mode-switch input[value='manual']");
+ await click(".query-mode-switch input[value='ai']");
+
+ assert
+ .dom(".query-new__fields [data-name='name'] input")
+ .hasValue("Edited name", "the edited name survives the mode switch");
+ assert
+ .dom(PROMPT_INPUT)
+ .hasValue("show me a value", "the prompt survives the mode switch");
+ });
});