A platform for community discussion. Free, open, simple.
DEV: Add an upcoming change toggler in the dev tools sidebar (#39027)
Martin Brennan24ac82667c69
diff --git a/config/locales/client.en.yml b/config/locales/client.en.ymlindex 433b8c85823..ae4251757ef 100644--- a/config/locales/client.en.yml+++ b/config/locales/client.en.yml@@ -397,6 +397,7 @@ en:toggle_verbose_localization: "Toggle verbose localization"toggle_mobile_view: "Toggle mobile view"disable_dev_tools: "Disable dev tools"+ toggle_upcoming_changes_debug: "Toggle upcoming changes debug"s3:regions:diff --git a/frontend/discourse/app/static/dev-tools/styles.css b/frontend/discourse/app/static/dev-tools/styles.cssindex 806fb02c32c..ea94152e2d3 100644--- a/frontend/discourse/app/static/dev-tools/styles.css+++ b/frontend/discourse/app/static/dev-tools/styles.css@@ -387,7 +387,8 @@font-size: 11px;}-.block-debug-menu {+.block-debug-menu,+.upcoming-changes-debug-menu {display: flex;flex-direction: column;gap: 8px;diff --git a/frontend/discourse/app/static/dev-tools/toolbar.gjs b/frontend/discourse/app/static/dev-tools/toolbar.gjsindex fc87e59c979..91ea3b8adcc 100644--- a/frontend/discourse/app/static/dev-tools/toolbar.gjs+++ b/frontend/discourse/app/static/dev-tools/toolbar.gjs@@ -13,6 +13,7 @@ import BlockDebugButton from "./block-debug/button";import MobileViewButton from "./mobile-view/button";import PluginOutletDebugButton from "./plugin-outlet-debug/button";import SafeModeButton from "./safe-mode/button";+import UpcomingChangesDebugButton from "./upcoming-changes-debug/button";import VerboseLocalizationButton from "./verbose-localization/button";export default class Toolbar extends Component {@@ -81,6 +82,7 @@ export default class Toolbar extends Component {</button><PluginOutletDebugButton /><BlockDebugButton />+ <UpcomingChangesDebugButton /><SafeModeButton /><VerboseLocalizationButton />{{#unless this.siteSettings.viewport_based_mobile_mode}}diff --git a/frontend/discourse/app/static/dev-tools/upcoming-changes-debug/button.gjs b/frontend/discourse/app/static/dev-tools/upcoming-changes-debug/button.gjsnew file mode 100644index 00000000000..1efbe255705--- /dev/null+++ b/frontend/discourse/app/static/dev-tools/upcoming-changes-debug/button.gjs@@ -0,0 +1,74 @@+import Component from "@glimmer/component";+import { fn } from "@ember/helper";+import { on } from "@ember/modifier";+import { action } from "@ember/object";+import { service } from "@ember/service";+import DMenu from "discourse/float-kit/components/d-menu";+import concatClass from "discourse/helpers/concat-class";+import icon from "discourse/helpers/d-icon";+import element from "discourse/helpers/element";+import { bind } from "discourse/lib/decorators";+import { i18n } from "discourse-i18n";++/**+ * Toggle button for the upcoming changes debug mode in the dev-tools toolbar.+ * Shows upcoming changes and allows you to toggle them on and off. Only works+ * on the client/UI, doesn't affect server-side behaviour of having upcoming+ * changes on.+ */+export default class UpcomingChangesDebugButton extends Component {+ @service siteSettings;++ get upcomingChanges() {+ return this.siteSettings.currentUserUpcomingChanges;+ }++ @action+ toggleUpcomingChangesDebug(changeSettingName) {+ // Does the same thing as onClientSettings in SubscribeUserNotificationsInit,+ // where we respond to MessageBus client settings changes from SiteSettingExtension.+ this.siteSettings[changeSettingName] =+ !this.siteSettings[changeSettingName];+ this.siteSettings.currentUserUpcomingChanges[changeSettingName] =+ !this.siteSettings.currentUserUpcomingChanges[changeSettingName];+ }++ @bind+ isChecked(changeSettingName) {+ return this.upcomingChanges[changeSettingName];+ }++ <template>+ <DMenu+ @identifier="upcoming-changes-debug-menu"+ @triggerClass={{concatClass+ "toggle-upcoming-changes-menu"+ (if this.isActive "--active")+ }}+ @triggerComponent={{element "button"}}+ @modalForMobile={{false}}+ @title={{i18n "dev_tools.toggle_upcoming_changes_debug"}}+ >+ <:trigger>+ {{icon "flask"}}+ </:trigger>+ <:content>+ <div class="upcoming-changes-debug-menu">+ {{#each-in this.upcomingChanges as |changeSettingName|}}+ <label>+ <input+ type="checkbox"+ checked={{this.isChecked changeSettingName}}+ {{on+ "change"+ (fn this.toggleUpcomingChangesDebug changeSettingName)+ }}+ />+ {{changeSettingName}}+ </label>+ {{/each-in}}+ </div>+ </:content>+ </DMenu>+ </template>+}diff --git a/spec/system/dev_tools_spec.rb b/spec/system/dev_tools_spec.rbindex 3fc0f483c2d..5c63699d368 100644--- a/spec/system/dev_tools_spec.rb+++ b/spec/system/dev_tools_spec.rb@@ -20,6 +20,35 @@ describe "Discourse dev tools" doendend+ describe "upcoming changes debugging" do+ before do+ mock_upcoming_change_metadata(+ {+ enable_upload_debug_mode: {+ impact: "other,developers",+ status: :experimental,+ impact_type: "other",+ impact_role: "developers",+ },+ },+ )+ end++ it "shows upcoming changes and allows you to toggle them on and off, impacting the client-side siteSettings service" do+ visit("/latest")+ toolbar.enable+ toolbar.open_upcoming_changes_menu+ expect(toolbar).to have_upcoming_changes_menu+ expect(toolbar.upcoming_change_site_setting_value("enable_upload_debug_mode")).to eq(false)+ toolbar.toggle_upcoming_changes_menu_item("enable_upload_debug_mode")+ expect(toolbar.upcoming_change_site_setting_value("enable_upload_debug_mode")).to eq(true)+ toolbar.toggle_upcoming_changes_menu_item("enable_upload_debug_mode")+ expect(toolbar.upcoming_change_site_setting_value("enable_upload_debug_mode")).to eq(false)+ toolbar.close_upcoming_changes_menu+ expect(toolbar).to have_no_upcoming_changes_menu+ end+ end+describe "plugin outlet debugging" doit "shows plugin outlet overlays with tooltips" dovisit("/latest")diff --git a/spec/system/page_objects/components/dev_tools/toolbar.rb b/spec/system/page_objects/components/dev_tools/toolbar.rbindex a5fbd927f15..a99b8a17462 100644--- a/spec/system/page_objects/components/dev_tools/toolbar.rb+++ b/spec/system/page_objects/components/dev_tools/toolbar.rb@@ -20,6 +20,38 @@ module PageObjectsselfend+ def open_upcoming_changes_menu+ find(".dev-tools-toolbar .toggle-upcoming-changes-menu").click+ self+ end++ def close_upcoming_changes_menu+ if has_upcoming_changes_menu?+ find(".dev-tools-toolbar .toggle-upcoming-changes-menu").click+ end++ self+ end++ def has_upcoming_changes_menu?+ page.has_css?(".upcoming-changes-debug-menu")+ end++ def has_no_upcoming_changes_menu?+ page.has_no_css?(".upcoming-changes-debug-menu")+ end++ def toggle_upcoming_changes_menu_item(item_name)+ find(".upcoming-changes-debug-menu label", text: item_name).click+ self+ end++ def upcoming_change_site_setting_value(site_setting_name)+ page.evaluate_script(+ "Discourse.__container__.lookup('service:site-settings').#{site_setting_name}",+ )+ end+def open_blocks_menufind(".dev-tools-toolbar .toggle-blocks").clickself