A platform for community discussion. Free, open, simple.
DEV: add sidebar-panel value transformer (#44540)
Kris54f67bdce0bb
diff --git a/frontend/discourse/app/lib/registry/transformers.js b/frontend/discourse/app/lib/registry/transformers.jsindex ea523763ce4..54f8079a76f 100644--- a/frontend/discourse/app/lib/registry/transformers.js+++ b/frontend/discourse/app/lib/registry/transformers.js@@ -150,6 +150,7 @@ export const VALUE_TRANSFORMERS = Object.freeze(["search-menu-search-context-enabled","search-menu-search-shortcuts-enabled","sidebar-anonymous-default-categories",+ "sidebar-panel","site-setting-allows-none","small-user-attrs","tag-separator",diff --git a/frontend/discourse/app/services/sidebar-state.js b/frontend/discourse/app/services/sidebar-state.jsindex 03df2f624a3..46ad7bebf41 100644--- a/frontend/discourse/app/services/sidebar-state.js+++ b/frontend/discourse/app/services/sidebar-state.js@@ -14,15 +14,14 @@ import {MAIN_PANEL,SEPARATED_MODE,} from "discourse/lib/sidebar/panels";+import { applyValueTransformer } from "discourse/lib/transformer";@disableImplicitInjectionsexport default class SidebarState extends Service {@service keyValueStore;@service router;- @tracked currentPanelKey = currentPanelKey;@tracked mode = COMBINED_MODE;- @tracked displaySwitchPanelButtons = false;@tracked filter = "";@tracked isForcingSidebar = false;@tracked forcingSidebarPanel = null;@@ -33,6 +32,32 @@ export default class SidebarState extends Service {previousState = {};#hiders = trackedSet();#revealedLinks = new WeakMap();+ @tracked _requestedPanelKey = currentPanelKey;+ @tracked _displaySwitchPanelButtons = false;++ /**+ * The panel the sidebar shows. Routes and plugins ask for a panel, and the+ * `sidebar-panel` value transformer can show a different one instead.+ */+ get currentPanelKey() {+ return applyValueTransformer("sidebar-panel", this._requestedPanelKey, {+ requestedPanelKey: this._requestedPanelKey,+ });+ }++ set currentPanelKey(key) {+ this._requestedPanelKey = key;+ }++ // Combined mode and panel switching are both about the panel that was asked+ // for, so neither applies once a transformer shows another one.+ get #panelTransformed() {+ return this.currentPanelKey !== this._requestedPanelKey;+ }++ get displaySwitchPanelButtons() {+ return this._displaySwitchPanelButtons && !this.#panelTransformed;+ }get sidebarHidden() {return this.#hiders.size > 0;@@ -43,7 +68,7 @@ export default class SidebarState extends Service {}get combinedMode() {- return this.mode === COMBINED_MODE;+ return this.mode === COMBINED_MODE && !this.#panelTransformed;}get showMainPanel() {@@ -94,10 +119,10 @@ export default class SidebarState extends Service {}setPanel(name) {- if (this.currentPanelKey) {+ if (this._requestedPanelKey) {this.setPreviousState();}- this.currentPanelKey = name;+ this._requestedPanelKey = name;this.restorePreviousState();}@@ -108,22 +133,22 @@ export default class SidebarState extends Service {setCombinedMode() {this.mode = COMBINED_MODE;- this.currentPanelKey = MAIN_PANEL;+ this._requestedPanelKey = MAIN_PANEL;this.hideSwitchPanelButtons();}showSwitchPanelButtons() {- this.displaySwitchPanelButtons = true;+ this._displaySwitchPanelButtons = true;}hideSwitchPanelButtons() {- this.displaySwitchPanelButtons = false;+ this._displaySwitchPanelButtons = false;}setPreviousState() {- this.previousState[this.currentPanelKey] = {+ this.previousState[this._requestedPanelKey] = {mode: this.mode,- displaySwitchPanelButtons: this.displaySwitchPanelButtons,+ displaySwitchPanelButtons: this._displaySwitchPanelButtons,};}@@ -150,7 +175,7 @@ export default class SidebarState extends Service {}restorePreviousState() {- const state = this.previousState[this.currentPanelKey];+ const state = this.previousState[this._requestedPanelKey];if (!state) {return;}diff --git a/frontend/discourse/tests/unit/services/sidebar-state-test.js b/frontend/discourse/tests/unit/services/sidebar-state-test.jsnew file mode 100644index 00000000000..c7db855ba47--- /dev/null+++ b/frontend/discourse/tests/unit/services/sidebar-state-test.js@@ -0,0 +1,75 @@+import { getOwner } from "@ember/owner";+import { setupTest } from "ember-qunit";+import { module, test } from "qunit";+import { withPluginApi } from "discourse/lib/plugin-api";+import { MAIN_PANEL } from "discourse/lib/sidebar/panels";++module("Unit | Service | sidebar-state", function (hooks) {+ setupTest(hooks);++ hooks.beforeEach(function () {+ this.sidebarState = getOwner(this).lookup("service:sidebar-state");+ });++ test("shows the panel that was asked for", function (assert) {+ this.sidebarState.setPanel("chat");+ assert.strictEqual(this.sidebarState.currentPanelKey, "chat");++ this.sidebarState.setCombinedMode();+ assert.strictEqual(this.sidebarState.currentPanelKey, MAIN_PANEL);+ assert.true(this.sidebarState.combinedMode);+ });++ test("the sidebar-panel transformer can show another panel", function (assert) {+ withPluginApi((api) => {+ api.registerValueTransformer("sidebar-panel", ({ value }) =>+ value === MAIN_PANEL || value === "chat" ? "custom" : value+ );+ });++ this.sidebarState.setPanel("chat");+ assert.strictEqual(this.sidebarState.currentPanelKey, "custom");++ this.sidebarState.setPanel("admin");+ assert.strictEqual(+ this.sidebarState.currentPanelKey,+ "admin",+ "panels the transformer leaves alone still show"+ );+ });++ test("a transformed panel isn't combined, and has no switch buttons", function (assert) {+ withPluginApi((api) => {+ api.registerValueTransformer("sidebar-panel", () => "custom");+ });++ this.sidebarState.setCombinedMode();+ assert.strictEqual(this.sidebarState.currentPanelKey, "custom");+ assert.false(this.sidebarState.combinedMode);++ this.sidebarState.showSwitchPanelButtons();+ assert.false(this.sidebarState.displaySwitchPanelButtons);+ });++ test("the transformer is told which panel was asked for", function (assert) {+ let requested;+ withPluginApi((api) => {+ api.registerValueTransformer("sidebar-panel", ({ value, context }) => {+ requested = context.requestedPanelKey;+ return value;+ });+ });++ this.sidebarState.setPanel("chat");+ assert.strictEqual(this.sidebarState.currentPanelKey, "chat");+ assert.strictEqual(requested, "chat");++ this.sidebarState.setCombinedMode();+ this.sidebarState.showSwitchPanelButtons();+ assert.true(+ this.sidebarState.combinedMode,+ "a panel left as asked keeps its mode"+ );+ assert.true(this.sidebarState.displaySwitchPanelButtons);+ });+});