Skip to content

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

UX: Dedicated page when viewing/editing a particular query (#39114)

Natalie Tay950b43006f9e
diff --git a/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/details.gjs b/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/details.gjs
deleted file mode 100644
index dac3975825d..00000000000
--- a/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/details.gjs
+++ /dev/null
@@ -1,284 +0,0 @@
-import Component from "@glimmer/component";
-import { Input } from "@ember/component";
-import { fn, hash } from "@ember/helper";
-import { on } from "@ember/modifier";
-import didInsert from "@ember/render-modifiers/modifiers/did-insert";
-import AceEditor from "discourse/components/ace-editor";
-import ConditionalLoadingSpinner from "discourse/components/conditional-loading-spinner";
-import DButton from "discourse/components/d-button";
-import DTextarea from "discourse/components/d-textarea";
-import TextField from "discourse/components/text-field";
-import icon from "discourse/helpers/d-icon";
-import draggable from "discourse/modifiers/draggable";
-import MultiSelect from "discourse/select-kit/components/multi-select";
-import { i18n } from "discourse-i18n";
-import CodeView from "discourse/plugins/discourse-data-explorer/discourse/components/code-view";
-import ExplorerSchema from "discourse/plugins/discourse-data-explorer/discourse/components/explorer-schema";
-import ParamInputForm from "discourse/plugins/discourse-data-explorer/discourse/components/param-input-form";
-import QueryResultsWrapper from "discourse/plugins/discourse-data-explorer/discourse/components/query-results-wrapper";
-
-export default class QueriesDetails extends Component {
- get showDestroyQuery() {
- return this.args.controller.model?.id > -1;
- }
-
- <template>
- {{#if @controller.disallow}}
- <h1>{{i18n "explorer.admins_only"}}</h1>
- {{else}}
-
- <div class="query-edit {{if @controller.editingName 'editing'}}">
- {{#if @controller.editingName}}
- <div class="name">
- <DButton
- @action={{@controller.goHome}}
- @icon="chevron-left"
- class="previous"
- />
- <DButton
- @action={{@controller.exitEdit}}
- @icon="xmark"
- class="previous"
- />
- <div class="name-text-field">
- <TextField
- @value={{@controller.model.name}}
- @onChange={{@controller.setDirty}}
- />
- </div>
- </div>
-
- <div class="desc">
- <DTextarea
- @value={{@controller.model.description}}
- @placeholder={{i18n "explorer.description_placeholder"}}
- @input={{@controller.setDirty}}
- />
- </div>
- {{else}}
- <div class="name">
- <DButton
- @action={{@controller.goHome}}
- @icon="chevron-left"
- class="previous"
- />
-
- <h1 class="query-name-display">
- <span>{{@controller.model.name}}</span>
- {{#unless @controller.editDisabled}}
- <DButton
- @action={{@controller.editName}}
- @icon="pencil"
- class="edit-query-name btn-transparent"
- />
- {{/unless}}
- </h1>
- </div>
-
- <div class="desc">
- {{@controller.model.description}}
- </div>
- {{/if}}
-
- {{#unless @controller.model.destroyed}}
- <div class="groups">
- <span class="label">{{i18n "explorer.allow_groups"}}</span>
- <span>
- <MultiSelect
- @value={{@controller.model.group_ids}}
- @content={{@controller.groupOptions}}
- @options={{hash allowAny=false}}
- @onChange={{@controller.updateGroupIds}}
- />
- </span>
- </div>
- {{/unless}}
-
- <div class="clear"></div>
-
- {{#if @controller.aiGenerating}}
- <div class="query-ai-generating">
- <ConditionalLoadingSpinner @condition={{true}} @size="small" />
- <span>{{i18n "explorer.ai.generating"}}</span>
- </div>
- {{/if}}
-
- {{#if @controller.editingQuery}}
- <div class="query-editor {{if @controller.hideSchema 'no-schema'}}">
- <div class="panels-flex">
- <div class="editor-panel">
- <AceEditor
- {{on "click" @controller.setDirty}}
- @content={{@controller.model.sql}}
- @onChange={{fn (mut @controller.model.sql)}}
- @mode="sql"
- @disabled={{@controller.editorDisabled}}
- @save={{@controller.save}}
- @submit={{@controller.saveAndRun}}
- />
- </div>
-
- <div class="right-panel">
- <ExplorerSchema
- @schema={{@controller.schema}}
- @hideSchema={{@controller.hideSchema}}
- @updateHideSchema={{@controller.updateHideSchema}}
- />
- </div>
- </div>
-
- <div
- class="grippie"
- {{draggable
- }}
- >
- {{icon "discourse-expand"}}
- </div>
-
- <div class="clear"></div>
- </div>
- {{else}}
- <div class="sql">
- <CodeView
- @value={{@controller.model.sql}}
- @codeClass="sql"
- @setDirty={{@controller.setDirty}}
- />
- </div>
- {{/if}}
-
- <div class="clear"></div>
-
- {{#if @controller.model.is_default}}
- <div class="default-query-notice alert alert-info">{{i18n
- "explorer.default_query_notice"
- }}</div>
- {{/if}}
-
- <div class="pull-left left-buttons">
- {{#if @controller.editingQuery}}
- <DButton
- class="btn-save-query"
- @action={{@controller.save}}
- @label="explorer.save"
- @disabled={{@controller.saveDisabled}}
- />
- {{else}}
- {{#unless @controller.editDisabled}}
- <DButton
- class="btn-edit-query"
- @action={{@controller.editQuery}}
- @label="explorer.edit"
- @icon="pencil"
- />
- {{/unless}}
- {{/if}}
-
- <DButton
- @action={{@controller.download}}
- @label="explorer.export"
- @disabled={{@controller.runDisabled}}
- @icon="download"
- />
-
- {{#if @controller.editingQuery}}
- <DButton
- @action={{@controller.showHelpModal}}
- @label="explorer.help.label"
- @icon="circle-question"
- />
- {{/if}}
- </div>
-
- <div class="pull-right right-buttons">
- {{#if @controller.model.destroyed}}
- <DButton
- @action={{@controller.recover}}
- @icon="arrow-rotate-left"
- @label="explorer.recover"
- />
- {{else}}
- {{#if @controller.editingQuery}}
- <DButton
- @action={{@controller.discard}}
- @icon="arrow-rotate-left"
- @label="explorer.undo"
- @disabled={{@controller.saveDisabled}}
- />
- {{/if}}
-
- {{#if this.showDestroyQuery}}
- <DButton
- @action={{@controller.destroyQuery}}
- @icon="trash-can"
- @label="explorer.delete"
- @disabled={{@controller.aiGenerating}}
- class="btn-danger"
- />
- {{/if}}
- {{/if}}
- </div>
- <div class="clear"></div>
- </div>
-
- <form class="query-run" {{on "submit" @controller.run}}>
- {{#if @controller.model.hasParams}}
- <ParamInputForm
- @initialValues={{@controller.parsedParams}}
- @paramInfo={{@controller.model.param_info}}
- @onRegisterApi={{@controller.onRegisterApi}}
- />
- {{/if}}
-
- {{#if @controller.runDisabled}}
- {{#if @controller.saveDisabled}}
- <DButton
- @label="explorer.run"
- @disabled="true"
- class="btn-primary query-run__submit"
- />
- {{else}}
- <DButton
- @action={{@controller.saveAndRun}}
- @icon="play"
- @label="explorer.saverun"
- class="btn-primary query-run__save-and-run"
- />
- {{/if}}
- {{else}}
- <DButton
- {{didInsert @controller.runOnLoad}}
- @action={{@controller.run}}
- @icon="play"
- @label="explorer.run"
- @disabled={{@controller.runDisabled}}
- @type="submit"
- class="btn-primary query-run__submit"
- />
- {{/if}}
-
- <label class="query-plan">
- <Input
- @type="checkbox"
- @checked={{@controller.explain}}
- name="explain"
- />
- {{i18n "explorer.explain_label"}}
- </label>
- </form>
- <hr />
-
- <ConditionalLoadingSpinner @condition={{@controller.loading}} />
-
- <QueryResultsWrapper
- @results={{@controller.results}}
- @showResults={{@controller.showResults}}
- @query={{@controller.model}}
- @content={{@controller.results}}
- />
- {{/if}}
- </template>
-}
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
new file mode 100644
index 00000000000..fb09a4bfaa8
--- /dev/null
+++ b/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/edit.gjs
@@ -0,0 +1,280 @@
+import Component from "@glimmer/component";
+import { Input } from "@ember/component";
+import { fn, hash } from "@ember/helper";
+import { on } from "@ember/modifier";
+import didInsert from "@ember/render-modifiers/modifiers/did-insert";
+import AceEditor from "discourse/components/ace-editor";
+import BackButton from "discourse/components/back-button";
+import ConditionalLoadingSpinner from "discourse/components/conditional-loading-spinner";
+import DButton from "discourse/components/d-button";
+import DTextarea from "discourse/components/d-textarea";
+import TextField from "discourse/components/text-field";
+import icon from "discourse/helpers/d-icon";
+import draggable from "discourse/modifiers/draggable";
+import MultiSelect from "discourse/select-kit/components/multi-select";
+import { i18n } from "discourse-i18n";
+import CodeView from "discourse/plugins/discourse-data-explorer/discourse/components/code-view";
+import ExplorerSchema from "discourse/plugins/discourse-data-explorer/discourse/components/explorer-schema";
+import ParamInputForm from "discourse/plugins/discourse-data-explorer/discourse/components/param-input-form";
+import QueryResultsWrapper from "discourse/plugins/discourse-data-explorer/discourse/components/query-results-wrapper";
+
+export default class QueriesEdit extends Component {
+ get showDestroyQuery() {
+ return this.args.controller.model?.id > -1;
+ }
+
+ <template>
+ <div class="admin-detail">
+ {{#if @controller.disallow}}
+ <h1>{{i18n "explorer.admins_only"}}</h1>
+ {{else}}
+ <BackButton
+ @route="adminPlugins.show.explorer.index"
+ @label="explorer.queries"
+ />
+
+ <div class="query-edit {{if @controller.editingName 'editing'}}">
+ {{#if @controller.editingName}}
+ <div class="name">
+ <DButton
+ @action={{@controller.exitEdit}}
+ @icon="xmark"
+ class="previous"
+ />
+ <div class="name-text-field">
+ <TextField
+ @value={{@controller.model.name}}
+ @onChange={{@controller.setDirty}}
+ />
+ </div>
+ </div>
+
+ <div class="desc">
+ <DTextarea
+ @value={{@controller.model.description}}
+ @placeholder={{i18n "explorer.description_placeholder"}}
+ @input={{@controller.setDirty}}
+ />
+ </div>
+ {{else}}
+ <div class="name">
+ <h1 class="query-name-display">
+ <span>{{@controller.model.name}}</span>
+ </h1>
+ {{#unless @controller.editDisabled}}
+ <DButton
+ @action={{@controller.editName}}
+ @icon="pencil"
+ class="edit-query-name btn-transparent"
+ />
+ {{/unless}}
+ </div>
+
+ <div class="desc">
+ {{@controller.model.description}}
+ </div>
+ {{/if}}
+
+ {{#unless @controller.model.destroyed}}
+ <div class="groups">
+ <span class="label">{{i18n "explorer.allow_groups"}}</span>
+ <span>
+ <MultiSelect
+ @value={{@controller.model.group_ids}}
+ @content={{@controller.groupOptions}}
+ @options={{hash allowAny=false}}
+ @onChange={{@controller.updateGroupIds}}
+ />
+ </span>
+ </div>
+ {{/unless}}
+
+ <div class="clear"></div>
+
+ {{#if @controller.aiGenerating}}
+ <div class="query-ai-generating">
+ <ConditionalLoadingSpinner @condition={{true}} @size="small" />
+ <span>{{i18n "explorer.ai.generating"}}</span>
+ </div>
+ {{/if}}
+
+ {{#if @controller.editingQuery}}
+ <div class="query-editor {{if @controller.hideSchema 'no-schema'}}">
+ <div class="panels-flex">
+ <div class="editor-panel">
+ <AceEditor
+ {{on "click" @controller.setDirty}}
+ @content={{@controller.model.sql}}
+ @onChange={{fn (mut @controller.model.sql)}}
+ @mode="sql"
+ @disabled={{@controller.editorDisabled}}
+ @save={{@controller.save}}
+ @submit={{@controller.saveAndRun}}
+ />
+ </div>
+
+ <div class="right-panel">
+ <ExplorerSchema
+ @schema={{@controller.schema}}
+ @hideSchema={{@controller.hideSchema}}
+ @updateHideSchema={{@controller.updateHideSchema}}
+ />
+ </div>
+ </div>
+
+ <div
+ class="grippie"
+ {{draggable
+ }}
+ >
+ {{icon "discourse-expand"}}
+ </div>
+
+ <div class="clear"></div>
+ </div>
+ {{else}}
+ <div class="sql">
+ <CodeView
+ @value={{@controller.model.sql}}
+ @codeClass="sql"
+ @setDirty={{@controller.setDirty}}
+ />
+ </div>
+ {{/if}}
+
+ <div class="clear"></div>
+
+ {{#if @controller.model.is_default}}
+ <div class="default-query-notice alert alert-info">{{i18n
+ "explorer.default_query_notice"
+ }}</div>
+ {{/if}}
+
+ <div class="pull-left left-buttons">
+ {{#if @controller.editingQuery}}
+ <DButton
+ class="btn-save-query"
+ @action={{@controller.save}}
+ @label="explorer.save"
+ @disabled={{@controller.saveDisabled}}
+ />
+ {{else}}
+ {{#unless @controller.editDisabled}}
+ <DButton
+ class="btn-edit-query"
+ @action={{@controller.editQuery}}
+ @label="explorer.edit"
+ @icon="pencil"
+ />
+ {{/unless}}
+ {{/if}}
+
+ <DButton
+ @action={{@controller.download}}
+ @label="explorer.export"
+ @disabled={{@controller.runDisabled}}
+ @icon="download"
+ />
+
+ {{#if @controller.editingQuery}}
+ <DButton
+ @action={{@controller.showHelpModal}}
+ @label="explorer.help.label"
+ @icon="circle-question"
+ />
+ {{/if}}
+ </div>
+
+ <div class="pull-right right-buttons">
+ {{#if @controller.model.destroyed}}
+ <DButton
+ @action={{@controller.recover}}
+ @icon="arrow-rotate-left"
+ @label="explorer.recover"
+ />
+ {{else}}
+ {{#if @controller.editingQuery}}
+ <DButton
+ @action={{@controller.discard}}
+ @icon="arrow-rotate-left"
+ @label="explorer.undo"
+ @disabled={{@controller.saveDisabled}}
+ />
+ {{/if}}
+
+ {{#if this.showDestroyQuery}}
+ <DButton
+ @action={{@controller.destroyQuery}}
+ @icon="trash-can"
+ @label="explorer.delete"
+ @disabled={{@controller.aiGenerating}}
+ class="btn-danger"
+ />
+ {{/if}}
+ {{/if}}
+ </div>
+ <div class="clear"></div>
+ </div>
+
+ <form class="query-run" {{on "submit" @controller.run}}>
+ {{#if @controller.model.hasParams}}
+ <ParamInputForm
+ @initialValues={{@controller.parsedParams}}
+ @paramInfo={{@controller.model.param_info}}
+ @onRegisterApi={{@controller.onRegisterApi}}
+ />
+ {{/if}}
+
+ {{#if @controller.runDisabled}}
+ {{#if @controller.saveDisabled}}
+ <DButton
+ @label="explorer.run"
+ @disabled="true"
+ class="btn-primary query-run__submit"
+ />
+ {{else}}
+ <DButton
+ @action={{@controller.saveAndRun}}
+ @icon="play"
+ @label="explorer.saverun"
+ class="btn-primary query-run__save-and-run"
+ />
+ {{/if}}
+ {{else}}
+ <DButton
+ {{didInsert @controller.runOnLoad}}
+ @action={{@controller.run}}
+ @icon="play"
+ @label="explorer.run"
+ @disabled={{@controller.runDisabled}}
+ @type="submit"
+ class="btn-primary query-run__submit"
+ />
+ {{/if}}
+
+ <label class="query-plan">
+ <Input
+ @type="checkbox"
+ @checked={{@controller.explain}}
+ name="explain"
+ />
+ {{i18n "explorer.explain_label"}}
+ </label>
+ </form>
+ <hr />
+
+ <ConditionalLoadingSpinner @condition={{@controller.loading}} />
+
+ <QueryResultsWrapper
+ @results={{@controller.results}}
+ @showResults={{@controller.showResults}}
+ @query={{@controller.model}}
+ @content={{@controller.results}}
+ />
+ {{/if}}
+ </div>
+ </template>
+}
diff --git a/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/index.gjs b/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/index.gjs
index 7ac7c086604..2e49e475499 100644
--- a/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/index.gjs
+++ b/plugins/discourse-data-explorer/admin/assets/javascripts/admin/templates/admin-plugins/show/explorer/index.gjs
@@ -129,7 +129,7 @@ export default <template>
<td class="d-table__cell --overview">
<LinkTo
class="d-table__overview-link"
- @route="adminPlugins.show.explorer.details"
+ @route="adminPlugins.show.explorer.edit"
@model={{query.id}}
>
<div
@@ -198,7 +198,7 @@ export default <template>
<div class="d-table__cell-actions">
<LinkTo
{{on "click" @controller.scrollTop}}
- @route="adminPlugins.show.explorer.details"
+ @route="adminPlugins.show.explorer.edit"
@model={{query.id}}
class="btn btn-default btn-small"
>
diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/details.js b/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/edit.js
similarity index 98%
rename from plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/details.js
rename to plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/edit.js
index 13916f25a36..653da3ba232 100644
--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/details.js
+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/edit.js
@@ -19,7 +19,6 @@ const AI_GENERATION_TIMEOUT_MS = 60000;
export default class PluginsExplorerController extends Controller {
@service modal;
@service appEvents;
- @service router;
@service messageBus;
@service siteSettings;
@service toasts;
@@ -238,11 +237,6 @@ export default class PluginsExplorerController extends Controller {
window.open(this.model.downloadUrl, "_blank");
}
- @action
- goHome() {
- this.router.transitionTo("adminPlugins.show.explorer");
- }
-
@action
showHelpModal() {
this.modal.show(QueryHelp);
diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/index.js b/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/index.js
index 9a38be6cabc..75837824ee3 100644
--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/index.js
+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/controllers/admin-plugins/show/explorer/index.js
@@ -35,7 +35,7 @@ export default class PluginsExplorerController extends Controller {
addCreatedRecord(record) {
this.model.content.push(record);
- this.router.transitionTo("adminPlugins.show.explorer.details", record.id);
+ this.router.transitionTo("adminPlugins.show.explorer.edit", record.id);
}
async _importQuery(file) {
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 b46a5b0caca..834ac080425 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
@@ -42,7 +42,7 @@ export default class AdminPluginsExplorerNew extends Controller {
data: { message: i18n("explorer.query_created") },
});
this.router.transitionTo(
- "adminPlugins.show.explorer.details",
+ "adminPlugins.show.explorer.edit",
result.target.id
);
} catch (error) {
diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/explorer-legacy-route-map.js b/plugins/discourse-data-explorer/assets/javascripts/discourse/explorer-legacy-route-map.js
index 8b793f78f8f..33389ef06c8 100644
--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/explorer-legacy-route-map.js
+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/explorer-legacy-route-map.js
@@ -4,7 +4,7 @@ export default {
map() {
this.route("explorer", function () {
this.route("queries", function () {
- this.route("details", { path: "/:query_id" });
+ this.route("edit", { path: "/:query_id" });
});
});
},
diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/explorer-route-map.js b/plugins/discourse-data-explorer/assets/javascripts/discourse/explorer-route-map.js
index 27db94b952a..bd87bc3dccf 100644
--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/explorer-route-map.js
+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/explorer-route-map.js
@@ -4,7 +4,7 @@ export default {
map() {
this.route("explorer", { path: "queries" }, function () {
this.route("new");
- this.route("details", { path: "/:query_id" });
+ this.route("edit", { path: "/:query_id" });
});
},
};
diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/explorer/queries/details.js b/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/explorer/queries/edit.js
similarity index 90%
rename from plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/explorer/queries/details.js
rename to plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/explorer/queries/edit.js
index 85b66e76cb4..df12b664d9d 100644
--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/explorer/queries/details.js
+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/explorer/queries/edit.js
@@ -8,7 +8,7 @@ export default class AdminPluginsExplorerQueriesDetailsRoute extends Route {
beforeModel(transition) {
this.router.replaceWith(
- "adminPlugins.show.explorer.details",
+ "adminPlugins.show.explorer.edit",
PLUGIN_ID,
transition.to.params.query_id,
{ queryParams: transition.to.queryParams }
diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/show/explorer/details.js b/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/show/explorer/edit.js
similarity index 100%
rename from plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/show/explorer/details.js
rename to plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/show/explorer/edit.js
diff --git a/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/show/explorer/index.js b/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/show/explorer/index.js
index 64cde4ca9eb..efde5ae95d7 100644
--- a/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/show/explorer/index.js
+++ b/plugins/discourse-data-explorer/assets/javascripts/discourse/routes/admin-plugins/show/explorer/index.js
@@ -9,7 +9,7 @@ export default class AdminPluginsExplorerIndex extends DiscourseRoute {
// Redirect old `?id=123` URLs to query details.
const { id, ...queryParams } = transition.to.queryParams;
if (id) {
- this.router.transitionTo("adminPlugins.show.explorer.details", id, {
+ this.router.transitionTo("adminPlugins.show.explorer.edit", id, {
queryParams,
});
}
diff --git a/plugins/discourse-data-explorer/spec/system/page_objects/pages/data_explorer_query_runner.rb b/plugins/discourse-data-explorer/spec/system/page_objects/pages/data_explorer_query_runner.rb
index 6e35391d44a..06575fb1b9f 100644
--- a/plugins/discourse-data-explorer/spec/system/page_objects/pages/data_explorer_query_runner.rb
+++ b/plugins/discourse-data-explorer/spec/system/page_objects/pages/data_explorer_query_runner.rb
@@ -8,8 +8,9 @@ module PageObjects
self
end
- def visit_admin_query(query_id, query_string: nil)
+ def visit_admin_query(query_id, query_string: nil, params: nil)
path = "/admin/plugins/discourse-data-explorer/queries/#{query_id}"
+ query_string = "params=#{CGI.escape(params.to_json)}" if params.present?
path += "?#{query_string}" if query_string.present?
page.visit(path)
self
diff --git a/plugins/discourse-data-explorer/spec/system/param_input_spec.rb b/plugins/discourse-data-explorer/spec/system/param_input_spec.rb
index 38a6365fd9d..317c071f437 100644
--- a/plugins/discourse-data-explorer/spec/system/param_input_spec.rb
+++ b/plugins/discourse-data-explorer/spec/system/param_input_spec.rb
@@ -45,20 +45,16 @@ RSpec.describe "Param input" do
SELECT 1
SQL
- fab!(:current_user, :admin)
+ fab!(:admin)
fab!(:all_params_query) do
- Fabricate(
- :query,
- name: "All params query",
- description: "",
- sql: ALL_PARAMS_SQL,
- user: current_user,
- )
+ Fabricate(:query, name: "All params query", description: "", sql: ALL_PARAMS_SQL, user: admin)
end
+ let(:query_runner) { PageObjects::Pages::DataExplorerQueryRunner.new }
+
before do
SiteSetting.data_explorer_enabled = true
- sign_in(current_user)
+ sign_in(admin)
end
it "correctly displays parameter input boxes" do
@@ -80,6 +76,78 @@ RSpec.describe "Param input" do
end
end
end
+
+ context "with a group_list param" do
+ fab!(:q2) do
+ Fabricate(
+ :query,
+ name: "My query with group_list",
+ description: "Test group_list query",
+ sql:
+ "-- [params]\n-- group_list :groups\n\nSELECT g.id,g.name FROM groups g WHERE g.name IN(:groups) ORDER BY g.name ASC",
+ user: admin,
+ )
+ end
+
+ it "supports setting a group_list param" do
+ query_runner.visit_admin_query(q2.id, params: { groups: "admins,trust_level_1" }).run_query
+
+ expect(query_runner).to have_result_header
+ expect(query_runner).to have_result_cell_at(1, 2, text: "admins")
+ expect(query_runner).to have_result_cell_at(2, 2, text: "trust_level_1")
+ end
+ end
+
+ context "with a current_user_id param" do
+ fab!(:query) { Fabricate(:query, name: "My current user query", sql: <<~SQL, user: admin) }
+ -- [params]
+ -- current_user_id :me
+ SELECT id, username FROM users WHERE id = :me
+ SQL
+
+ it "auto-injects the current user's id without showing an input field" do
+ query_runner.visit_admin_query(query.id)
+
+ expect(query_runner).to have_no_params
+ query_runner.run_query
+
+ expect(query_runner).to have_result_header
+ expect(query_runner).to have_result_row_count(1)
+ expect(query_runner).to have_result_cell(admin.username)
+ end
+ end
+
+ context "with a sql query with default params" do
+ fab!(:query_with_defaults) do
+ Fabricate(
+ :query,
+ name: "Query with defaults",
+ sql:
+ "-- [params]\n-- int :limit = 10\n-- string :name = hello world\n\nSELECT :name AS name LIMIT :limit",
+ user: admin,
+ )
+ end
+
+ it "sets up the input fields with the default params" do
+ query_runner.visit_admin_query(query_with_defaults.id)
+
+ expect(page).to have_field("limit", with: "10")
+ expect(page).to have_field("name", with: "hello world")
+ end
+
+ it "overrides sql params when URL params are provided" do
+ query_runner.visit_admin_query(
+ query_with_defaults.id,
+ params: {
+ limit: "25",
+ name: "override",
+ },
+ )
+
+ expect(page).to have_field("limit", with: "25")
+ expect(page).to have_field("name", with: "override")
+ end
+ end
end
def simple_normalize(type, value)
diff --git a/plugins/discourse-data-explorer/spec/system/query_runner_spec.rb b/plugins/discourse-data-explorer/spec/system/query_runner_spec.rb
index 88a225e846f..7074dbfea46 100644
--- a/plugins/discourse-data-explorer/spec/system/query_runner_spec.rb
+++ b/plugins/discourse-data-explorer/spec/system/query_runner_spec.rb
@@ -25,7 +25,7 @@ RSpec.describe "Data explorer query runner" do
find(".query-run .btn-primary").click
expect(page).to have_css(".query-results .result-header")
- find(".query-edit .previous").click
+ find(".back-button").click
first("a[href='/admin/plugins/discourse-data-explorer/queries/#{query_b.id}']").click
expect(page).to have_no_css(".query-results .result-header")
end
@@ -88,47 +88,4 @@ RSpec.describe "Data explorer query runner" do
expect(page).to have_current_path("/admin/plugins/discourse-data-explorer/queries")
end
end
-
- context "with a group_list param" do
- fab!(:q2) do
- Fabricate(
- :query,
- name: "My query with group_list",
- description: "Test group_list query",
- sql:
- "-- [params]\n-- group_list :groups\n\nSELECT g.id,g.name FROM groups g WHERE g.name IN(:groups) ORDER BY g.name ASC",
- user: admin,
- )
- end
-
- it "supports setting a group_list param" do
- query_runner.visit_admin_query(
- q2.id,
- query_string: "params=%7B\"groups\"%3A\"admins%2Ctrust_level_1\"%7D",
- ).run_query
-
- expect(query_runner).to have_result_header
- expect(query_runner).to have_result_cell_at(1, 2, text: "admins")
- expect(query_runner).to have_result_cell_at(2, 2, text: "trust_level_1")
- end
- end
-
- context "with a current_user_id param" do
- fab!(:query) { Fabricate(:query, name: "My current user query", sql: <<~SQL, user: admin) }
- -- [params]
- -- current_user_id :me
- SELECT id, username FROM users WHERE id = :me
- SQL
-
- it "auto-injects the current user's id without showing an input field" do
- query_runner.visit_admin_query(query.id)
-
- expect(query_runner).to have_no_params
- query_runner.run_query
-
- expect(query_runner).to have_result_header
- expect(query_runner).to have_result_row_count(1)
- expect(query_runner).to have_result_cell(admin.username)
- end
- end
end