Skip to content

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

DEV: modernize admin nav, fix unconfigured state (#42182)

Kris87bd7db2612c
diff --git a/plugins/discourse-patreon/assets/javascripts/discourse/controllers/admin-plugins/patreon.js b/plugins/discourse-patreon/admin/assets/javascripts/discourse/controllers/admin-plugins/show/patreon-filters.js
similarity index 97%
rename from plugins/discourse-patreon/assets/javascripts/discourse/controllers/admin-plugins/patreon.js
rename to plugins/discourse-patreon/admin/assets/javascripts/discourse/controllers/admin-plugins/show/patreon-filters.js
index a2b0cfc8f35..41e6f78f58b 100644
--- a/plugins/discourse-patreon/assets/javascripts/discourse/controllers/admin-plugins/patreon.js
+++ b/plugins/discourse-patreon/admin/assets/javascripts/discourse/controllers/admin-plugins/show/patreon-filters.js
@@ -94,7 +94,7 @@ export default class AdminPluginsPatreonController extends Controller {
this.set("updatingData", false);
- const refreshUrl = getURL("/admin/plugins/patreon");
+ const refreshUrl = getURL("/admin/plugins/discourse-patreon/filters");
this.dialog.alert({
message: i18n("patreon.refresh_page"),
didConfirm: () => (window.location.pathname = refreshUrl),
diff --git a/plugins/discourse-patreon/assets/javascripts/discourse/routes/admin-plugins/patreon.js b/plugins/discourse-patreon/admin/assets/javascripts/discourse/routes/admin-plugins/show/patreon-filters.js
similarity index 78%
rename from plugins/discourse-patreon/assets/javascripts/discourse/routes/admin-plugins/patreon.js
rename to plugins/discourse-patreon/admin/assets/javascripts/discourse/routes/admin-plugins/show/patreon-filters.js
index b4671c4d485..8895674825c 100644
--- a/plugins/discourse-patreon/assets/javascripts/discourse/routes/admin-plugins/patreon.js
+++ b/plugins/discourse-patreon/admin/assets/javascripts/discourse/routes/admin-plugins/show/patreon-filters.js
@@ -17,6 +17,10 @@ export default class AdminPluginsPatreon extends DiscourseRoute {
Group.findAll({ ignore_automatic: true }),
])
.then(([result, groups]) => {
+ if (result.unconfigured) {
+ return { unconfigured: true };
+ }
+
groups = groups.map((g) => {
return { id: g.id, name: g.name };
});
@@ -32,6 +36,19 @@ export default class AdminPluginsPatreon extends DiscourseRoute {
}
setupController(controller, model) {
+ // popupAjaxError swallows the rejection, so a failed request arrives here
+ // as an undefined model rather than as an error substate.
+ if (!model || model.unconfigured) {
+ controller.setProperties({
+ unconfigured: !!model?.unconfigured,
+ model: trackedArray([]),
+ groups: [],
+ rewards: {},
+ last_sync_at: null,
+ });
+ return;
+ }
+
const rewards = model.rewards;
const groups = model.groups;
const filtersArray = Object.entries(model.filters).map(([k, v]) => {
@@ -51,6 +68,7 @@ export default class AdminPluginsPatreon extends DiscourseRoute {
});
controller.setProperties({
+ unconfigured: false,
model: trackedArray(filtersArray),
groups,
rewards,
diff --git a/plugins/discourse-patreon/admin/assets/javascripts/discourse/templates/admin-plugins/show/patreon-filters.gjs b/plugins/discourse-patreon/admin/assets/javascripts/discourse/templates/admin-plugins/show/patreon-filters.gjs
new file mode 100644
index 00000000000..2e611fa405e
--- /dev/null
+++ b/plugins/discourse-patreon/admin/assets/javascripts/discourse/templates/admin-plugins/show/patreon-filters.gjs
@@ -0,0 +1,98 @@
+import { trustHTML } from "@ember/template";
+import AdminConfigAreaEmptyList from "discourse/admin/components/admin-config-area-empty-list";
+import ComboBox from "discourse/select-kit/components/combo-box";
+import ListSetting from "discourse/select-kit/components/list-setting";
+import DButton from "discourse/ui-kit/d-button";
+import dFormatDate from "discourse/ui-kit/helpers/d-format-date";
+import { i18n } from "discourse-i18n";
+
+const META_URL =
+ "https://meta.discourse.org/t/configure-patreon-integration-with-discourse/62380";
+
+export default <template>
+ <section id="patreon">
+ {{#if @controller.unconfigured}}
+ <AdminConfigAreaEmptyList
+ @emptyLabelTranslated={{i18n "patreon.unconfigured" url=META_URL}}
+ @ctaLabel="patreon.configure_tokens"
+ @ctaRoute="adminPlugins.show.settings"
+ @ctaRouteModels="discourse-patreon"
+ class="patreon-unconfigured"
+ />
+ {{else}}
+ <table>
+ <thead>
+ <tr>
+ <th>{{i18n "patreon.group"}}</th>
+ <th>{{i18n "patreon.rewards"}}</th>
+ <th></th>
+ </tr>
+ </thead>
+
+ <tbody>
+ {{#each @controller.model as |rule|}}
+ <tr class>
+ <td>{{rule.group}}</td>
+ <td>{{rule.rewards}}</td>
+ <td>
+ <div class="pull-right">
+ <DButton
+ @action={{@controller.delete}}
+ @actionParam={{rule}}
+ @icon="far-trash-can"
+ @title="patreon.delete"
+ class="delete btn-danger"
+ />
+ </div>
+ </td>
+ </tr>
+ {{/each}}
+ </tbody>
+
+ <tfoot>
+ <tr class="new-filter">
+ <td><ComboBox
+ @value={{@controller.editing.group_id}}
+ @content={{@controller.groups}}
+ @nameProperty="name"
+ @valueProperty="id"
+ @none="patreon.select_group"
+ /></td>
+ <td><ListSetting
+ @value={{@controller.editing.reward_list}}
+ @choices={{@controller.rewardsNames}}
+ class="rewards"
+ /></td>
+ <td>
+ <div class="pull-right">
+ <DButton
+ @action={{@controller.save}}
+ @icon="check"
+ @title="patreon.save"
+ class="save btn-primary"
+ />
+ </div>
+ </td>
+ </tr>
+ </tfoot>
+ </table>
+
+ <p>{{i18n "patreon.help_text"}}</p>
+
+ <DButton
+ @action={{@controller.updateData}}
+ @icon="refresh"
+ @disabled={{@controller.updatingData}}
+ @title="patreon.update_data"
+ @label="patreon.update_data"
+ />
+
+ {{#if @controller.last_sync_at}}
+ <span class="last_synced">
+ {{i18n "patreon.last_synced"}}:
+ {{trustHTML (dFormatDate @controller.last_sync_at leaveAgo="true")}}
+ </span>
+ {{/if}}
+ {{/if}}
+ </section>
+</template>
diff --git a/plugins/discourse-patreon/app/controllers/patreon/patreon_admin_controller.rb b/plugins/discourse-patreon/app/controllers/patreon/patreon_admin_controller.rb
index 3a6d3d3a3ed..908ef4fcc8b 100644
--- a/plugins/discourse-patreon/app/controllers/patreon/patreon_admin_controller.rb
+++ b/plugins/discourse-patreon/app/controllers/patreon/patreon_admin_controller.rb
@@ -4,13 +4,15 @@ class Patreon::PatreonAdminController < Admin::AdminController
requires_plugin Patreon::PLUGIN_NAME
before_action :patreon_enabled?
- before_action :patreon_tokens_present?
+ before_action :patreon_tokens_present?, except: %i[list]
def patreon_enabled?
raise Discourse::NotFound unless SiteSetting.patreon_enabled
end
def list
+ return render json: { unconfigured: true } if !patreon_tokens?
+
filters = PluginStore.get(Patreon::PLUGIN_NAME, "filters") || {}
rewards = Patreon::Reward.all
last_sync = Patreon.get("last_sync") || {}
@@ -85,6 +87,11 @@ class Patreon::PatreonAdminController < Admin::AdminController
render json: { email: Patreon::Patron.attr("email", user) }
end
+ def patreon_tokens?
+ SiteSetting.patreon_creator_access_token.present? &&
+ SiteSetting.patreon_creator_refresh_token.present?
+ end
+
def patreon_tokens_present?
if SiteSetting.patreon_creator_access_token.blank?
raise Discourse::SiteSettingMissing.new("patreon_creator_access_token")
diff --git a/plugins/discourse-patreon/assets/javascripts/discourse/initializers/patreon-admin-plugin-configuration-nav.js b/plugins/discourse-patreon/assets/javascripts/discourse/initializers/patreon-admin-plugin-configuration-nav.js
index 8d2a2623112..8704272df7d 100644
--- a/plugins/discourse-patreon/assets/javascripts/discourse/initializers/patreon-admin-plugin-configuration-nav.js
+++ b/plugins/discourse-patreon/assets/javascripts/discourse/initializers/patreon-admin-plugin-configuration-nav.js
@@ -13,6 +13,12 @@ export default {
withPluginApi((api) => {
api.setAdminPluginIcon(PLUGIN_ID, "fab-patreon");
+ api.addAdminPluginConfigurationNav(PLUGIN_ID, [
+ {
+ label: "patreon.header.rules",
+ route: "adminPlugins.show.patreon-filters",
+ },
+ ]);
});
},
};
diff --git a/plugins/discourse-patreon/assets/javascripts/discourse/patreon-route-map.js b/plugins/discourse-patreon/assets/javascripts/discourse/patreon-route-map.js
index 57141c49bdb..f59cbe143f4 100644
--- a/plugins/discourse-patreon/assets/javascripts/discourse/patreon-route-map.js
+++ b/plugins/discourse-patreon/assets/javascripts/discourse/patreon-route-map.js
@@ -1,7 +1,9 @@
export default {
- resource: "admin.adminPlugins",
- path: "/plugins",
+ resource: "admin.adminPlugins.show",
+
map() {
- this.route("patreon");
+ // Route names are shared across every plugin nested under the show route,
+ // so this one keeps the plugin prefix.
+ this.route("patreon-filters", { path: "filters" });
},
};
diff --git a/plugins/discourse-patreon/assets/javascripts/discourse/templates/admin/plugins-patreon.gjs b/plugins/discourse-patreon/assets/javascripts/discourse/templates/admin/plugins-patreon.gjs
deleted file mode 100644
index d922c519069..00000000000
--- a/plugins/discourse-patreon/assets/javascripts/discourse/templates/admin/plugins-patreon.gjs
+++ /dev/null
@@ -1,85 +0,0 @@
-import { trustHTML } from "@ember/template";
-import ComboBox from "discourse/select-kit/components/combo-box";
-import ListSetting from "discourse/select-kit/components/list-setting";
-import DButton from "discourse/ui-kit/d-button";
-import dFormatDate from "discourse/ui-kit/helpers/d-format-date";
-import { i18n } from "discourse-i18n";
-
-export default <template>
- <section id="patreon">
- <h1>{{i18n "patreon.header.rules"}}</h1>
- <table>
- <thead>
- <tr>
- <th>{{i18n "patreon.group"}}</th>
- <th>{{i18n "patreon.rewards"}}</th>
- <th></th>
- </tr>
- </thead>
-
- <tbody>
- {{#each @controller.model as |rule|}}
- <tr class>
- <td>{{rule.group}}</td>
- <td>{{rule.rewards}}</td>
- <td>
- <div class="pull-right">
- <DButton
- @action={{@controller.delete}}
- @actionParam={{rule}}
- @icon="far-trash-can"
- @title="patreon.delete"
- class="delete btn-danger"
- />
- </div>
- </td>
- </tr>
- {{/each}}
- </tbody>
-
- <tfoot>
- <tr class="new-filter">
- <td><ComboBox
- @value={{@controller.editing.group_id}}
- @content={{@controller.groups}}
- @nameProperty="name"
- @valueProperty="id"
- @none="patreon.select_group"
- /></td>
- <td><ListSetting
- @value={{@controller.editing.reward_list}}
- @choices={{@controller.rewardsNames}}
- class="rewards"
- /></td>
- <td>
- <div class="pull-right">
- <DButton
- @action={{@controller.save}}
- @icon="check"
- @title="patreon.save"
- class="save btn-primary"
- />
- </div>
- </td>
- </tr>
- </tfoot>
- </table>
-
- <p>{{i18n "patreon.help_text"}}</p>
-
- <DButton
- @action={{@controller.updateData}}
- @icon="refresh"
- @disabled={{@controller.updatingData}}
- @title="patreon.update_data"
- @label="patreon.update_data"
- />
-
- {{#if @controller.last_sync_at}}
- <span class="last_synced">
- {{i18n "patreon.last_synced"}}:
- {{trustHTML (dFormatDate @controller.last_sync_at leaveAgo="true")}}
- </span>
- {{/if}}
- </section>
-</template>
diff --git a/plugins/discourse-patreon/config/locales/client.en.yml b/plugins/discourse-patreon/config/locales/client.en.yml
index f53aa33105e..25e423a79cb 100644
--- a/plugins/discourse-patreon/config/locales/client.en.yml
+++ b/plugins/discourse-patreon/config/locales/client.en.yml
@@ -13,6 +13,8 @@ en:
title: 'Patreon'
header:
rules: 'Filters'
+ unconfigured: "Patreon is not connected yet. Please see <a href='%{url}' target='_blank'>the documentation on Discourse Meta</a> for details."
+ configure_tokens: 'Go to settings'
group: 'Group'
rewards: 'Rewards'
filter: 'Filter'
diff --git a/plugins/discourse-patreon/plugin.rb b/plugins/discourse-patreon/plugin.rb
index 76a24574214..2b0f1363832 100644
--- a/plugins/discourse-patreon/plugin.rb
+++ b/plugins/discourse-patreon/plugin.rb
@@ -46,10 +46,11 @@ after_initialize do
Discourse::Application.routes.prepend { mount Patreon::Engine, at: "/patreon" }
- add_admin_route "patreon.title", "patreon"
+ add_admin_route "patreon.title", "discourse-patreon", use_new_show_route: true
Discourse::Application.routes.append do
- get "/admin/plugins/patreon" => "admin/plugins#index", :constraints => AdminConstraint.new
+ get "/admin/plugins/discourse-patreon/filters" => "admin/plugins#index",
+ :constraints => AdminConstraint.new
get "/admin/plugins/patreon/list" => "patreon/patreon_admin#list",
:constraints => AdminConstraint.new
get "/u/:username/patreon_email" => "patreon/patreon_admin#email",
diff --git a/plugins/discourse-patreon/spec/requests/patreon_admin_controller_spec.rb b/plugins/discourse-patreon/spec/requests/patreon_admin_controller_spec.rb
index 9fba842cfb7..7f0ba8a422e 100644
--- a/plugins/discourse-patreon/spec/requests/patreon_admin_controller_spec.rb
+++ b/plugins/discourse-patreon/spec/requests/patreon_admin_controller_spec.rb
@@ -25,6 +25,15 @@ describe Patreon::PatreonAdminController do
expect(result["rewards"].count).to eq(2)
end
+ it "reports that it is unconfigured when the creator tokens are missing" do
+ SiteSetting.patreon_creator_access_token = ""
+
+ get "/patreon/list.json"
+
+ expect(response.status).to eq(200)
+ expect(response.parsed_body).to eq("unconfigured" => true)
+ end
+
it "should display list of rewards" do
get "/patreon/rewards.json"